Struct PropertyGuard

pub struct PropertyGuard<'fwnode, 'name, T> { /* private fields */ }

A helper for reading device properties.

Use Self::required_by if a missing property is considered a bug and Self::optional otherwise.

For convenience, Self::or and Self::or_default are provided.

Implementations

impl<T> PropertyGuard<'_, '_, T>

pub fn required_by(self, dev: &Device) -> Result<T>

Access the property, indicating it is required.

If the property is not present, the error is automatically logged. If a missing property is not an error, use Self::optional instead. The device is required to associate the log with it.

pub fn optional(self) -> Option<T>

Access the property, indicating it is optional.

In contrast to Self::required_by, no error message is logged if the property is not present.

pub fn or(self, default: T) -> T

Access the property or the specified default value.

Do not pass a sentinel value as default to detect a missing property. Use Self::required_by or Self::optional instead.

impl<T: Default> PropertyGuard<'_, '_, T>

pub fn or_default(self) -> T

Access the property or a default value.

Use Self::or to specify a custom default value.