Struct rustix::ioctl::Getter

pub struct Getter<Opcode, Output> {
    output: MaybeUninit<Output>,
    _opcode: PhantomData<Opcode>,
}

Implements the traditional “getter” pattern for ioctls.

Some ioctls just read data into the userspace. As this is a popular pattern this structure implements it.

Fields

output: MaybeUninit<Output>

The output data.

_opcode: PhantomData<Opcode>

The opcode.

Implementations

impl<Opcode: CompileTimeOpcode, Output> Getter<Opcode, Output>

pub unsafe fn new() -> Self

Create a new getter-style ioctl object.

Safety

• Opcode must provide a valid opcode.
• For this opcode, Output must be the type that the kernel expects to write into.

Trait Implementations

impl<Opcode: CompileTimeOpcode, Output> Debug for Getter<Opcode, Output>

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

Formats the value using the given formatter.

impl<Opcode: CompileTimeOpcode, Output> Ioctl for Getter<Opcode, Output>

type Output = Output

The type of the output data.

const IS_MUTATING: bool = true

Does the ioctl mutate any data in the userspace?

const OPCODE: Opcode = Opcode::OPCODE

The opcode used by this ioctl command.

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

Get a pointer to the data to be passed to the ioctl command.

unsafe fn output_from_ptr( _: IoctlOutput, ptr: *mut c_void, ) -> Result<Self::Output>

Cast the output data to the correct type.