Struct sourceview5::Encoding

pub struct Encoding { /* private fields */ }

Character encoding.

The #GtkSourceEncoding boxed type represents a character encoding. It is used for example by #GtkSourceFile. Note that the text in GTK widgets is always encoded in UTF-8.

GLib type: Boxed type with copy-on-clone semantics.

Implementations

impl Encoding

pub fn as_ptr(&self) -> *mut GtkSourceEncoding

Return the inner pointer to the underlying C value.

pub unsafe fn from_glib_ptr_borrow(ptr: &*mut GtkSourceEncoding) -> &Self

Borrows the underlying C value.

pub unsafe fn from_glib_ptr_borrow_mut( ptr: &mut *mut GtkSourceEncoding, ) -> &mut Self

Borrows the underlying C value mutably.

impl Encoding

pub fn charset(&self) -> GString

Gets the character set of the #GtkSourceEncoding, such as “UTF-8” or “ISO-8859-1”.

Returns

the character set of the #GtkSourceEncoding.

pub fn name(&self) -> GString

Gets the name of the #GtkSourceEncoding such as “Unicode” or “Western”.

Returns

the name of the #GtkSourceEncoding.

pub fn to_str(&self) -> GString

Returns

a string representation. Free with g_free() when no longer needed.

pub fn all() -> Vec<Encoding>

Gets all encodings.

Returns

a list of all #GtkSourceEncoding’s. Free with g_slist_free().

pub fn current() -> Encoding

Gets the #GtkSourceEncoding for the current locale.

See also get_charset().

Returns

the current locale encoding.

pub fn default_candidates() -> Vec<Encoding>

Gets the list of default candidate encodings to try when loading a file.

See FileLoader::set_candidate_encodings().

This function returns a different list depending on the current locale (i.e. language, country and default encoding). The UTF-8 encoding and the current locale encoding are guaranteed to be present in the returned list.

Returns

the list of default candidate encodings. Free with g_slist_free().

pub fn from_charset(charset: &str) -> Option<Encoding>

Gets a #GtkSourceEncoding from a character set such as “UTF-8” or “ISO-8859-1”.

charset

a character set.

Returns

the corresponding #GtkSourceEncoding, or None if not found.

pub fn utf8() -> Encoding

Returns

the UTF-8 encoding.

Trait Implementations

impl Clone for Encoding

fn clone(&self) -> Self

Copies the boxed type with the type-specific copy function.

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

Performs copy-assignment from source.

impl Debug for Encoding

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

Formats the value using the given formatter.

impl Display for Encoding

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

Formats the value using the given formatter.

impl From<Encoding> for Value

fn from(o: Encoding) -> Self

Converts to this type from the input type.

impl HasParamSpec for Encoding

type ParamSpec = ParamSpecBoxed

type SetValue = Encoding

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

type BuilderFn = fn(_: &str) -> ParamSpecBoxedBuilder<'_, Encoding>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Encoding

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

Feeds this value into the given Hasher.

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 Encoding

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

This method returns an Ordering between self and other.

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 PartialEq for Encoding

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

This method tests for self and other values to be equal, and is used by ==.

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 PartialOrd for Encoding

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

This method returns an ordering between self and other values if one exists.

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 Encoding

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Encoding

impl StructuralPartialEq for Encoding