Struct sourceview5::FileLoader

pub struct FileLoader { /* private fields */ }

Load a file into a GtkSourceBuffer.

A FileLoader object permits to load the contents of a gio::File or a gio::InputStream into a Buffer.

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

Running a FileLoader is an undoable action for the Buffer.

After a file loading, the buffer is reset to the contents provided by the gio::File or gio::InputStream, so the buffer is set as “unmodified”, that is, [TextBufferExtManual::set_modified()][crate::gtk::prelude::TextBufferExtManual::set_modified()] is called with false. If the contents isn’t saved somewhere (for example if you load from stdin), then you should probably call [TextBufferExtManual::set_modified()][crate::gtk::prelude::TextBufferExtManual::set_modified()] with true after calling FileLoader::load_finish().

Properties

buffer

The #GtkSourceBuffer to load the contents into. The #GtkSourceFileLoader object has a weak reference to the buffer.

Readable | Writeable | Construct Only

file

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

Readable | Writeable | Construct Only

input-stream

The #GInputStream to load. Useful for reading stdin. If this property is set, the #GtkSourceFileLoader:location property is ignored.

Readable | Writeable | Construct Only

location

The #GFile to load. If the #GtkSourceFileLoader:input-stream is None, by default the location is taken from the #GtkSourceFile at construction time.

Readable | Writeable | Construct Only

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl FileLoader

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

Creates a new FileLoader object. The contents is read from the File’s location.

If not already done, call SourceFileExt::set_location() before calling this constructor. The previous location is anyway not needed, because as soon as the file loading begins, the @buffer is emptied.

buffer

the #GtkSourceBuffer to load the contents into.

file

the #GtkSourceFile.

Returns

a new #GtkSourceFileLoader object.

pub fn from_stream( buffer: &impl IsA<Buffer>, file: &impl IsA<File>, stream: &impl IsA<InputStream>, ) -> FileLoader

Creates a new #GtkSourceFileLoader object. The contents is read from @stream.

buffer

the #GtkSourceBuffer to load the contents into.

file

the #GtkSourceFile.

stream

the #GInputStream to load, e.g. stdin.

Returns

a new #GtkSourceFileLoader object.

pub fn builder() -> FileLoaderBuilder

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

This method returns an instance of FileLoaderBuilder which can be used to create FileLoader objects.

pub fn buffer(&self) -> Buffer

Returns

the #GtkSourceBuffer to load the contents into.

pub fn compression_type(&self) -> CompressionType

Returns

the detected compression type.

pub fn encoding(&self) -> Encoding

Returns

the detected file encoding.

pub fn file(&self) -> File

Returns

the #GtkSourceFile.

pub fn input_stream(&self) -> Option<InputStream>

Returns

the #GInputStream to load, or None if a #GFile is used.

pub fn location(&self) -> Option<File>

Returns

the #GFile to load, or None if an input stream is used.

pub fn newline_type(&self) -> NewlineType

Returns

the detected newline type.

impl FileLoader

pub fn load_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 load_async<Q: FnOnce(Result<(), Error>) + Send + 'static>( &self, io_priority: Priority, cancellable: Option<&impl IsA<Cancellable>>, callback: Q, )

Loads asynchronously the file or input stream contents into the Buffer.

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 load_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 FileLoader

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 FileLoader

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

Formats the value using the given formatter.

impl Default for FileLoader

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for FileLoader

type ParamSpec = ParamSpecObject

type SetValue = FileLoader

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for FileLoader

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 FileLoader

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 FileLoader

type Parent = Object

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

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 FileLoader

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 FileLoader

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FileLoader