Struct rustix::ioctl::Getter

source ·
pub struct Getter<Opcode, Output> {
    output: MaybeUninit<Output>,
    _opcode: PhantomData<Opcode>,
}
Expand description

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§

source§

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

source

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§

source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

§

type Output = Output

The type of the output data. Read more
source§

const IS_MUTATING: bool = true

Does the ioctl mutate any data in the userspace? Read more
source§

const OPCODE: Opcode = Opcode::OPCODE

The opcode used by this ioctl command. Read more
source§

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

Get a pointer to the data to be passed to the ioctl command. Read more
source§

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

Cast the output data to the correct type. Read more

Auto Trait Implementations§

§

impl<Opcode, Output> Freeze for Getter<Opcode, Output>
where Output: Freeze,

§

impl<Opcode, Output> RefUnwindSafe for Getter<Opcode, Output>
where Opcode: RefUnwindSafe, Output: RefUnwindSafe,

§

impl<Opcode, Output> Send for Getter<Opcode, Output>
where Opcode: Send, Output: Send,

§

impl<Opcode, Output> Sync for Getter<Opcode, Output>
where Opcode: Sync, Output: Sync,

§

impl<Opcode, Output> Unpin for Getter<Opcode, Output>
where Opcode: Unpin, Output: Unpin,

§

impl<Opcode, Output> UnwindSafe for Getter<Opcode, Output>
where Opcode: UnwindSafe, Output: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.