Struct kernel::miscdev::Options

pub struct Options<'a> { /* private fields */ }

Options which can be used to configure how a misc device is registered.

Examples

fn example(
    reg: Pin<&mut miscdev::Registration<impl file::Operations<OpenData = ()>>>,
    parent: &dyn RawDevice,
) -> Result {
    miscdev::Options::new()
        .mode(0o600)
        .minor(10)
        .parent(parent)
        .register(reg, fmt!("sample"), ())
}

Implementations

impl<'a> Options<'a>

pub const fn new() -> Self

Creates new Options instance with the required fields.

pub const fn minor(&mut self, v: i32) -> &mut Self

Sets the minor device number.

pub const fn mode(&mut self, m: u16) -> &mut Self

Sets the device mode.

This is usually an octal number and describes who can perform read/write/execute operations on the device.

pub const fn parent(&mut self, p: &'a dyn RawDevice) -> &mut Self

Sets the device parent.

pub fn register<T: Operations>(
    &self,
    reg: Pin<&mut Registration<T>>,
    name: Arguments<'_>,
    open_data: T::OpenData
) -> Result

Registers a misc device using the configured options.

pub fn register_new<T: Operations>(
    &self,
    name: Arguments<'_>,
    open_data: T::OpenData
) -> Result<Pin<Box<Registration<T>>>>

Allocates a new registration of a misc device and completes the registration with the configured options.

Trait Implementations

impl<'a> Default for Options<'a>

fn default() -> Options<'a>

Returns the “default value” for a type.