Struct glib::KeyFile

source · [−]

#[repr(transparent)]
pub struct KeyFile { /* private fields */ }

Implementations

source

impl KeyFile

source

pub fn new() -> KeyFile

source

pub fn comment(
 &self,
 group_name: Option<&str>,
 key: Option<&str>
) -> Result<GString, Error>

source

pub fn double(&self, group_name: &str, key: &str) -> Result<f64, Error>

source

pub fn double_list(
 &self,
 group_name: &str,
 key: &str
) -> Result<Vec<f64>, Error>

source

pub fn integer_list(
 &self,
 group_name: &str,
 key: &str
) -> Result<Vec<i32>, Error>

source

pub fn keys(&self, group_name: &str) -> Result<(Vec<GString>, usize), Error>

source

pub fn locale_for_key(
 &self,
 group_name: &str,
 key: &str,
 locale: Option<&str>
) -> Option<GString>

Available on crate feature v2_56 only.

source

pub fn start_group(&self) -> Option<GString>

source

pub fn uint64(&self, group_name: &str, key: &str) -> Result<u64, Error>

source

pub fn value(&self, group_name: &str, key: &str) -> Result<GString, Error>

source

pub fn has_group(&self, group_name: &str) -> bool

source

pub fn load_from_bytes(
 &self,
 bytes: &Bytes,
 flags: KeyFileFlags
) -> Result<(), Error>

Available on crate feature v2_50 only.

source

pub fn load_from_data(
 &self,
 data: &str,
 flags: KeyFileFlags
) -> Result<(), Error>

source

pub fn load_from_file(
 &self,
 file: impl AsRef<Path>,
 flags: KeyFileFlags
) -> Result<(), Error>

source

pub fn remove_comment(
 &self,
 group_name: Option<&str>,
 key: Option<&str>
) -> Result<(), Error>

source

pub fn remove_group(&self, group_name: &str) -> Result<(), Error>

source

pub fn remove_key(&self, group_name: &str, key: &str) -> Result<(), Error>

source

pub fn set_boolean(&self, group_name: &str, key: &str, value: bool)

Associates a new boolean value with key under group_name. If key cannot be found then it is created.

pub fn set_comment(
 &self,
 group_name: Option<&str>,
 key: Option<&str>,
 comment: &str
) -> Result<(), Error>

Places a comment above key from group_name.

If key is None then comment will be written above group_name. If both key and group_name are None, then comment will be written above the first group in the file.

Note that this function prepends a ‘#’ comment marker to each line of comment.

Returns

true if the comment was written, false otherwise

source

pub fn set_double(&self, group_name: &str, key: &str, value: f64)

Associates a new double value with key under group_name. If key cannot be found then it is created.

pub fn set_int64(&self, group_name: &str, key: &str, value: i64)

Associates a new integer value with key under group_name. If key cannot be found then it is created.

pub fn set_integer(&self, group_name: &str, key: &str, value: i32)

Associates a new integer value with key under group_name. If key cannot be found then it is created.

pub fn set_list_separator(&self, separator: Char)

Sets the character which is used to separate values in lists. Typically ‘;’ or ‘,’ are used as separators. The default list separator is ‘;’.

pub fn set_locale_string(
    &self,
    group_name: &str,
    key: &str,
    locale: &str,
    string: &str
)

Associates a string value for key and locale under group_name. If the translation for key cannot be found then it is created.

pub fn set_string(&self, group_name: &str, key: &str, string: &str)

Associates a new string value with key under group_name. If key cannot be found then it is created. If group_name cannot be found then it is created. Unlike set_value(), this function handles characters that need escaping, such as newlines.

`group_name`

a group name

`key`

a key

`string`

a string

source

pub fn set_uint64(&self, group_name: &str, key: &str, value: u64)

Associates a new integer value with key under group_name. If key cannot be found then it is created.

`group_name`

a group name

`key`

a key

`value`

an integer value

source

pub fn set_value(&self, group_name: &str, key: &str, value: &str)

Associates a new value with key under group_name.

If key cannot be found then it is created. If group_name cannot be found then it is created. To set an UTF-8 string which may contain characters that need escaping (such as newlines or spaces), use set_string().

`group_name`

a group name

`key`

a key

`value`

a string

source

impl KeyFile

source

pub fn save_to_file<T: AsRef<Path>>(&self, filename: T) -> Result<(), Error>

source

pub fn load_from_data_dirs<T: AsRef<Path>>(
 &self,
 file: T,
 flags: KeyFileFlags
) -> Result<PathBuf, Error>

source

pub fn load_from_dirs<T: AsRef<Path>, U: AsRef<Path>>(
 &self,
 file: T,
 search_dirs: &[U],
 flags: KeyFileFlags
) -> Result<PathBuf, Error>

source

pub fn to_data(&self) -> GString

This function outputs self as a string.

Note that this function never reports an error, so it is safe to pass None as error.

Returns

a newly allocated string holding the contents of the KeyFile

`length`

return location for the length of the returned string, or None

source

pub fn boolean(&self, group_name: &str, key: &str) -> Result<bool, Error>

source

pub fn has_key(&self, group_name: &str, key: &str) -> Result<bool, Error>

source

pub fn boolean_list(
 &self,
 group_name: &str,
 key: &str
) -> Result<Vec<bool>, Error>

source

pub fn string(&self, group_name: &str, key: &str) -> Result<GString, Error>

source

pub fn string_list(
 &self,
 group_name: &str,
 key: &str
) -> Result<Vec<GString>, Error>

source

pub fn locale_string(
 &self,
 group_name: &str,
 key: &str,
 locale: Option<&str>
) -> Result<GString, Error>

source

pub fn locale_string_list(
 &self,
 group_name: &str,
 key: &str,
 locale: Option<&str>
) -> Result<Vec<GString>, Error>

Trait Implementations

source

impl Clone for KeyFile

source

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for KeyFile

source

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

Formats the value using the given formatter. Read more

source

impl Default for KeyFile

source

fn default() -> Self

Returns the “default value” for a type. Read more

source

impl Hash for KeyFile

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

impl Ord for KeyFile

source

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

source

impl PartialEq<KeyFile> for KeyFile

source

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

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

source

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

This method tests for !=.

source

impl PartialOrd<KeyFile> for KeyFile

source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

impl StaticType for KeyFile

source

fn static_type() -> Type

Returns the type identifier of Self.

source

impl Eq for KeyFile

source

impl StructuralEq for KeyFile

source

impl StructuralPartialEq for KeyFile

Auto Trait Implementations

impl RefUnwindSafe for KeyFile

impl !Send for KeyFile

impl !Sync for KeyFile

impl Unpin for KeyFile

impl UnwindSafe for KeyFile

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> StaticTypeExt for T where
T: StaticType,

source

fn ensure_type()

Ensures that the type has been registered with the type system.

source

impl<T> ToClosureReturnValue for T where
T: ToValue,

source

fn to_closure_return_value(&self) -> Option<Value>

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T> TryFromClosureReturnValue for T where
T: 'static + for<'a> FromValue<'a> + StaticType,

source

fn try_from_closure_return_value(v: Option<Value>) -> Result<T, BoolError>

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

Struct glib::KeyFile

Implementations

impl KeyFile

pub fn new() -> KeyFile

pub fn comment( &self, group_name: Option<&str>, key: Option<&str>) -> Result<GString, Error>

pub fn double(&self, group_name: &str, key: &str) -> Result<f64, Error>

pub fn double_list( &self, group_name: &str, key: &str) -> Result<Vec<f64>, Error>

pub fn groups(&self) -> (Vec<GString>, usize)

pub fn int64(&self, group_name: &str, key: &str) -> Result<i64, Error>

pub fn integer(&self, group_name: &str, key: &str) -> Result<i32, Error>

pub fn integer_list( &self, group_name: &str, key: &str) -> Result<Vec<i32>, Error>

pub fn keys(&self, group_name: &str) -> Result<(Vec<GString>, usize), Error>

pub fn locale_for_key( &self, group_name: &str, key: &str, locale: Option<&str>) -> Option<GString>

pub fn start_group(&self) -> Option<GString>

pub fn uint64(&self, group_name: &str, key: &str) -> Result<u64, Error>

pub fn value(&self, group_name: &str, key: &str) -> Result<GString, Error>

pub fn has_group(&self, group_name: &str) -> bool

pub fn load_from_bytes( &self, bytes: &Bytes, flags: KeyFileFlags) -> Result<(), Error>

pub fn load_from_data( &self, data: &str, flags: KeyFileFlags) -> Result<(), Error>

pub fn load_from_file( &self, file: impl AsRef<Path>, flags: KeyFileFlags) -> Result<(), Error>

pub fn remove_comment( &self, group_name: Option<&str>, key: Option<&str>) -> Result<(), Error>

pub fn remove_group(&self, group_name: &str) -> Result<(), Error>

pub fn remove_key(&self, group_name: &str, key: &str) -> Result<(), Error>

pub fn set_boolean(&self, group_name: &str, key: &str, value: bool)

pub fn set_comment( &self, group_name: Option<&str>, key: Option<&str>, comment: &str) -> Result<(), Error>

pub fn set_double(&self, group_name: &str, key: &str, value: f64)

pub fn set_int64(&self, group_name: &str, key: &str, value: i64)

pub fn set_integer(&self, group_name: &str, key: &str, value: i32)

pub fn set_list_separator(&self, separator: Char)

pub fn set_locale_string( &self, group_name: &str, key: &str, locale: &str, string: &str)

pub fn set_string(&self, group_name: &str, key: &str, string: &str)

pub fn set_uint64(&self, group_name: &str, key: &str, value: u64)

pub fn set_value(&self, group_name: &str, key: &str, value: &str)

impl KeyFile

pub fn save_to_file<T: AsRef<Path>>(&self, filename: T) -> Result<(), Error>

pub fn load_from_data_dirs<T: AsRef<Path>>( &self, file: T, flags: KeyFileFlags) -> Result<PathBuf, Error>

pub fn load_from_dirs<T: AsRef<Path>, U: AsRef<Path>>( &self, file: T, search_dirs: &[U], flags: KeyFileFlags) -> Result<PathBuf, Error>

pub fn to_data(&self) -> GString

pub fn boolean(&self, group_name: &str, key: &str) -> Result<bool, Error>

pub fn has_key(&self, group_name: &str, key: &str) -> Result<bool, Error>

pub fn boolean_list( &self, group_name: &str, key: &str) -> Result<Vec<bool>, Error>

pub fn string(&self, group_name: &str, key: &str) -> Result<GString, Error>

pub fn string_list( &self, group_name: &str, key: &str) -> Result<Vec<GString>, Error>

pub fn locale_string( &self, group_name: &str, key: &str, locale: Option<&str>) -> Result<GString, Error>

pub fn locale_string_list( &self, group_name: &str, key: &str, locale: Option<&str>) -> Result<Vec<GString>, Error>

Trait Implementations

impl Clone for KeyFile

fn clone(&self) -> Self

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

impl Debug for KeyFile

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

impl Default for KeyFile

fn default() -> Self

impl Hash for KeyFile

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

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

impl Ord for KeyFile

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

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

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

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

impl PartialEq<KeyFile> for KeyFile

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

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

impl PartialOrd<KeyFile> for KeyFile

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

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

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

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

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

impl StaticType for KeyFile

fn static_type() -> Type

impl Eq for KeyFile

impl StructuralEq for KeyFile

impl StructuralPartialEq for KeyFile

Auto Trait Implementations

impl RefUnwindSafe for KeyFile

impl !Send for KeyFile

impl !Sync for KeyFile

impl Unpin for KeyFile

pub fn comment(
&self,
group_name: Option<&str>,
key: Option<&str>
) -> Result<GString, Error>

pub fn double_list(
&self,
group_name: &str,
key: &str
) -> Result<Vec<f64>, Error>

pub fn integer_list(
&self,
group_name: &str,
key: &str
) -> Result<Vec<i32>, Error>

pub fn locale_for_key(
&self,
group_name: &str,
key: &str,
locale: Option<&str>
) -> Option<GString>

pub fn load_from_bytes(
&self,
bytes: &Bytes,
flags: KeyFileFlags
) -> Result<(), Error>

pub fn load_from_data(
&self,
data: &str,
flags: KeyFileFlags
) -> Result<(), Error>

pub fn load_from_file(
&self,
file: impl AsRef<Path>,
flags: KeyFileFlags
) -> Result<(), Error>

pub fn remove_comment(
&self,
group_name: Option<&str>,
key: Option<&str>
) -> Result<(), Error>

pub fn set_comment(
&self,
group_name: Option<&str>,
key: Option<&str>,
comment: &str
) -> Result<(), Error>

pub fn set_locale_string(
&self,
group_name: &str,
key: &str,
locale: &str,
string: &str
)

pub fn load_from_data_dirs<T: AsRef<Path>>(
&self,
file: T,
flags: KeyFileFlags
) -> Result<PathBuf, Error>

pub fn load_from_dirs<T: AsRef<Path>, U: AsRef<Path>>(
&self,
file: T,
search_dirs: &[U],
flags: KeyFileFlags
) -> Result<PathBuf, Error>

pub fn boolean_list(
&self,
group_name: &str,
key: &str
) -> Result<Vec<bool>, Error>

pub fn string_list(
&self,
group_name: &str,
key: &str
) -> Result<Vec<GString>, Error>

pub fn locale_string(
&self,
group_name: &str,
key: &str,
locale: Option<&str>
) -> Result<GString, Error>

pub fn locale_string_list(
&self,
group_name: &str,
key: &str,
locale: Option<&str>
) -> Result<Vec<GString>, Error>

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> StaticTypeExt for T where
T: StaticType,

impl<T> ToClosureReturnValue for T where
T: ToValue,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T> TryFromClosureReturnValue for T where
T: 'static + for<'a> FromValue<'a> + StaticType,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<'a, T, C> FromValueOptional<'a> for T where
T: FromValue<'a, Checker = C>,
C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,