Struct sourceview5::FileSaver

pub struct FileSaver { /* private fields */ }

Save a Buffer into a file.

A FileSaver object permits to save a Buffer into a gio::File.

A file saver should be used only for one save operation, including errors handling. If an error occurs, you can reconfigure the saver and relaunch the operation with save_async().

Properties

buffer

The #GtkSourceBuffer to save. The #GtkSourceFileSaver object has a weak reference to the buffer.

Readable | Writeable | Construct Only

compression-type

The compression type.

Readable | Writeable | Construct

encoding

The file’s encoding.

Readable | Writeable | Construct

file

The #GtkSourceFile. The #GtkSourceFileSaver object has a weak reference to the file.

Readable | Writeable | Construct Only

flags

File saving flags.

Readable | Writeable | Construct

location

The #GFile where to save the buffer. By default the location is taken from the #GtkSourceFile at construction time.

Readable | Writeable | Construct Only

newline-type

The newline type.

Readable | Writeable | Construct

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl FileSaver

pub fn new(buffer: &impl IsA<Buffer>, file: &impl IsA<File>) -> FileSaver

Creates a new #GtkSourceFileSaver object. The @buffer will be saved to the File’s location.

This constructor is suitable for a simple “save” operation, when the @file already contains a non-None location.

buffer

the #GtkSourceBuffer to save.

file

the #GtkSourceFile.

Returns

a new #GtkSourceFileSaver object.

pub fn with_target( buffer: &impl IsA<Buffer>, file: &impl IsA<File>, target_location: &impl IsA<File>, ) -> FileSaver

Creates a new #GtkSourceFileSaver object with a target location.

When the file saving is finished successfully, @target_location is set to the @file’s location property. If an error occurs, the previous valid location is still available in File.

This constructor is suitable for a “save as” operation, or for saving a new buffer for the first time.

buffer

the #GtkSourceBuffer to save.

file

the #GtkSourceFile.

target_location

the #GFile where to save the buffer to.

Returns

a new #GtkSourceFileSaver object.

pub fn builder() -> FileSaverBuilder

Creates a new builder-pattern struct instance to construct FileSaver objects.

This method returns an instance of FileSaverBuilder which can be used to create FileSaver objects.

pub fn buffer(&self) -> Buffer

Returns

the #GtkSourceBuffer to save.

pub fn compression_type(&self) -> CompressionType

Returns

the compression type.

pub fn encoding(&self) -> Encoding

Returns

the encoding.

pub fn file(&self) -> File

Returns

the #GtkSourceFile.

pub fn flags(&self) -> FileSaverFlags

Returns

the flags.

pub fn location(&self) -> File

Returns

the #GFile where to save the buffer to.

pub fn newline_type(&self) -> NewlineType

Returns

the newline type.

pub fn set_compression_type(&self, compression_type: CompressionType)

Sets the compression type. By default the compression type is taken from the #GtkSourceFile.

compression_type

the new compression type.

pub fn set_encoding(&self, encoding: Option<&Encoding>)

Sets the encoding. If @encoding is None, the UTF-8 encoding will be set.

By default the encoding is taken from the #GtkSourceFile.

encoding

the new encoding, or None for UTF-8.

pub fn set_flags(&self, flags: FileSaverFlags)

flags

the new flags.

pub fn set_newline_type(&self, newline_type: NewlineType)

Sets the newline type. By default the newline type is taken from the #GtkSourceFile.

newline_type

the new newline type.

pub fn connect_compression_type_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_encoding_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_flags_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_newline_type_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

impl FileSaver

pub fn save_async<Q: FnOnce(Result<(), Error>) + Send + 'static>( &self, io_priority: Priority, cancellable: Option<&impl IsA<Cancellable>>, callback: Q, )

Saves asynchronously the buffer into the file.

See the Gio::AsyncResult documentation to know how to use this function.

io_priority

the I/O priority of the request. E.g. G_PRIORITY_LOW, G_PRIORITY_DEFAULT or G_PRIORITY_HIGH.

cancellable

optional #GCancellable object, None to ignore.

progress_callback

function to call back with progress information, or None if progress information is not needed.

progress_callback_data

user data to pass to @progress_callback.

progress_callback_notify

function to call on @progress_callback_data when the @progress_callback is no longer needed, or None.

callback

a #GAsyncReadyCallback to call when the request is satisfied.

pub fn save_async_with_callback<P: FnMut(i64, i64) + Send + 'static, Q: FnOnce(Result<(), Error>) + Send + 'static>( &self, io_priority: Priority, cancellable: Option<&impl IsA<Cancellable>>, progress_callback: P, callback: Q, )

pub fn save_future( &self, io_priority: Priority, ) -> (Pin<Box<dyn Future<Output = Result<(), Error>> + 'static>>, Pin<Box<dyn Stream<Item = (i64, i64)> + 'static>>)

Trait Implementations

impl Clone for FileSaver

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FileSaver

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FileSaver

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for FileSaver

type ParamSpec = ParamSpecObject

type SetValue = FileSaver

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, FileSaver>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for FileSaver

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FileSaver

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for FileSaver

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for FileSaver

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for FileSaver

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for FileSaver

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FileSaver