Struct elektra::readonly::ReadOnly

pub struct ReadOnly<T: ReadableKey> { /* fields omitted */ }

A wrapper that provides only readable methods on a key.

Methods

impl<T: ReadableKey> ReadOnly<T>

pub fn key(&self) -> &T

Returns the inner key

Trait Implementations

impl<T: ReadableKey> ReadableKey for ReadOnly<T>

type GetValue = T::GetValue

The type returned by value.

unsafe fn from_ptr(ptr: *mut Key) -> Self

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<T: Eq + ReadableKey> Eq for ReadOnly<T>

impl<T: ReadableKey> AsRef<_Key> for ReadOnly<T>

fn as_ref(&self) -> &Key

Performs the conversion.

impl<T: PartialOrd + ReadableKey> PartialOrd<ReadOnly<T>> for ReadOnly<T>

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

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

fn lt(&self, other: &ReadOnly<T>) -> bool

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

fn le(&self, other: &ReadOnly<T>) -> bool

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

fn gt(&self, other: &ReadOnly<T>) -> bool

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

fn ge(&self, other: &ReadOnly<T>) -> bool

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

impl<T: PartialEq + ReadableKey> PartialEq<ReadOnly<T>> for ReadOnly<T>

fn eq(&self, other: &ReadOnly<T>) -> bool

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

fn ne(&self, other: &ReadOnly<T>) -> bool

This method tests for !=.

impl<T: Ord + ReadableKey> Ord for ReadOnly<T>

fn cmp(&self, other: &ReadOnly<T>) -> 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<T: Debug + ReadableKey> Debug for ReadOnly<T>

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

Formats the value using the given formatter.