Struct elektra::key::BinaryKey

pub struct BinaryKey<'a> { /* fields omitted */ }

Methods

impl<'a> BinaryKey<'a>

pub fn duplicate<'b>(&'a self) -> BinaryKey<'b>

Returns a deep copy of the key.

Important traits for MetaIter<'a, T>

impl<'a, T: WriteableKey> Iterator for MetaIter<'a, T> type Item = ReadOnly<StringKey<'a>>;

pub fn meta_iter<'b>(&'b self) -> MetaIter<'b, BinaryKey<'a>>

Returns an iterator over the key's metakeys.

Important traits for NameIter<'a, T>

impl<'a, T: ReadableKey> Iterator for NameIter<'a, T> type Item = Cow<'a, str>;

pub fn name_iter<'b>(&'b self) -> NameIter<'b, BinaryKey<'a>>

Returns an iterator over the key's name.

Trait Implementations

impl<'a> ReadableKey for BinaryKey<'a>

type GetValue = Vec<u8>

The type returned by value.

unsafe fn from_ptr(ptr: *mut Key) -> BinaryKey<'a>

Construct a new key from a raw key pointer

fn value(&self) -> Self::GetValue

Returns the value this key holds. # Examples # use elektra::{StringKey,WriteableKey,ReadableKey}; # fn main() -> Result<(), Box<dyn std::error::Error>> { let mut key = StringKey::new("user/sw/app")?; key.set_value("myvalue"); assert_eq!(key.value(), "myvalue"); # # Ok(()) # }

fn name(&self) -> Cow<str>

Return the name of the key as a borrowed slice.

fn basename(&self) -> Cow<str>

Return the basename of the key as a borrowed slice.

fn basename_size(&self) -> isize

Calculates number of bytes needed to store basename of key.

fn fullname_size(&self) -> usize

Bytes needed to store the key name including user domain and ending NULL.

fn get_ref(&self) -> isize

Return how many references the key has.

fn current_meta(&self) -> ReadOnly<StringKey>

Returns the value of a meta-information which is current.

fn fullname(&self) -> String

Get key full name, including the user domain name.

fn namespace(&self) -> u32

Returns the namespace of the name of this key. Note that there are some convenience methods implemented.

fn is_spec(&self) -> bool

Determines if the key is in the spec namespace

fn is_dir(&self) -> bool

Determines if the key is in the dir namespace

fn is_proc(&self) -> bool

Determines if the key is in the proc namespace

fn is_user(&self) -> bool

Determines if the key is in the user namespace

fn is_system(&self) -> bool

Determines if the key is in the system namespace

fn is_cascading(&self) -> bool

Determines if the key is a cascading key

fn value_size(&self) -> usize

Returns the number of bytes needed to store the key's value, including the NULL terminator.

fn is_binary(&self) -> bool

Returns true if the key has a binary value.

fn is_string(&self) -> bool

Returns true if the key has a string value.

fn is_below(&self, other: &Self) -> bool where
    Self: Sized, 

Returns true if other is below self

fn is_direct_below(&self, other: &Self) -> bool where
    Self: Sized, 

Returns true if other is directly below self

fn is_inactive(&self) -> bool

Returns true if the key is inactive.

fn meta(&self, metaname: &str) -> Result<ReadOnly<StringKey>, KeyNotFoundError> where
    Self: Sized, 

Returns the metadata with the given metaname

impl<'a> WriteableKey for BinaryKey<'a>

type SetValue = &'a [u8]

The value that is passed to set_value.

fn as_ptr(&mut self) -> *mut Key

Returns the raw pointer of the key. Should be used with caution. In particular, the pointer should only be modified with elektra_sys::key* functions, but keyDel should not be called.

fn set_value(&mut self, value: Self::SetValue)

Set the value of the key.

fn new(name: &str) -> Result<Self, KeyNameInvalidError> where
    Self: Sized, 

Construct a new key with a name.

fn new_empty() -> Self where
    Self: Sized, 

Construct a new nameless key.

unsafe fn inc_ref(&mut self) -> isize

Increment the viability of a key object. Returns the value of the new reference counter.

unsafe fn dec_ref(&mut self) -> isize

Decrement the viability of a key object. Returns the value of the new reference counter.

fn clear(&mut self)

Clears the key. After this call you will receive a fresh key.

fn set_name(&mut self, name: &str) -> Result<u32, KeyNameInvalidError>

Set the name of a key. Must adhere to the rules for keynames otherwise a KeyNameInvalidError is returned. Note that the error could also represent a KeyNameReadOnlyError, but the C-API doesn't allow for the distinction, so only one error can be returned. Returns the size in bytes of this new key name including the ending NUL.

fn set_basename(&mut self, basename: &str) -> Result<(), KeyNameReadOnlyError>

Set the basename of the key Returns a KeyNameReadOnlyError if the key is part of a keyset.

fn add_basename(&mut self, basename: &str) -> Result<(), KeyNameReadOnlyError>

Add a basename to the key Returns a KeyNameReadOnlyError if the key is part of a keyset.

fn add_name(&mut self, name: &str) -> Result<(), KeyNameInvalidError>

Add an already escaped name to the keyname. Returns an KeyNameInvalidError if the name is not a valid escaped name.

fn copy_all_meta(&mut self, source: &Self) where
    Self: Sized, 

Copies all metadata from source to the self.

fn copy_meta(&mut self, source: &Self, metaname: &str) -> i32 where
    Self: Sized, 

Copy metakey with name metaname from source to self.

fn set_meta(
    &mut self,
    metaname: &str,
    metavalue: &str
) -> Result<usize, KeyNameInvalidError>

Set a new meta-information. Returns the size of the new meta information on success, or a KeyNameInvalidError if the name is invalid.

fn delete_meta(&mut self, metaname: &str) -> Result<usize, KeyNameInvalidError>

Delete the metadata at metaname Returns the size of the new meta information on success, or a KeyNameInvalidError if the name is invalid or out of memory.

fn rewind_meta(&mut self)

Rewind the internal iterator to first metadata. Note that iterators already call this method when they're created.

impl<'_> AsRef<_Key> for BinaryKey<'_>

fn as_ref(&self) -> &Key

Performs the conversion.

impl<'_> Eq for BinaryKey<'_>

impl<'_> Drop for BinaryKey<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl<'_> Default for BinaryKey<'_>

fn default() -> Self

Returns the "default value" for a type.

impl<'_> Clone for BinaryKey<'_>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'_> PartialOrd<BinaryKey<'_>> for BinaryKey<'_>

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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<'_> PartialEq<BinaryKey<'_>> for BinaryKey<'_>

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'_> Ord for BinaryKey<'_>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl<'_, '_> From<StringKey<'_>> for BinaryKey<'_>

fn from(sk: StringKey) -> Self

Performs the conversion.

impl<'_, '_> From<BinaryKey<'_>> for StringKey<'_>

fn from(bk: BinaryKey) -> Self

Performs the conversion.

impl<'a> Debug for BinaryKey<'a>

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

Formats the value using the given formatter.