Struct rustix::ioctl::Opcode

pub struct Opcode {
    raw: RawOpcode,
}

The opcode used by an Ioctl.

Fields

raw: RawOpcode

The raw opcode.

Implementations

impl Opcode

pub const fn old(raw: RawOpcode) -> Self

Create a new old Opcode from a raw opcode.

Rather than being a composition of several attributes, old opcodes are just numbers. In general most drivers follow stricter conventions, but older drivers may still use this strategy.

pub const fn from_components( direction: Direction, group: u8, number: u8, data_size: usize, ) -> Self

Create a new opcode from a direction, group, number, and size.

This corresponds to the C macro _IOC(direction, group, number, size)

pub const fn none<T>(group: u8, number: u8) -> Self

Create a new non-mutating opcode from a group, a number, and the type of data.

This corresponds to the C macro _IO(group, number) when T is zero sized.

pub const fn read<T>(group: u8, number: u8) -> Self

Create a new reading opcode from a group, a number and the type of data.

This corresponds to the C macro _IOR(group, number, T).

pub const fn write<T>(group: u8, number: u8) -> Self

Create a new writing opcode from a group, a number and the type of data.

This corresponds to the C macro _IOW(group, number, T).

pub const fn read_write<T>(group: u8, number: u8) -> Self

Create a new reading and writing opcode from a group, a number and the type of data.

This corresponds to the C macro _IOWR(group, number, T).

pub fn raw(self) -> RawOpcode

Get the raw opcode.

Trait Implementations

impl Clone for Opcode

fn clone(&self) -> Opcode

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Opcode

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

Formats the value using the given formatter.

impl Hash for Opcode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Opcode

fn cmp(&self, other: &Opcode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Opcode

fn eq(&self, other: &Opcode) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Opcode

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

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

fn lt(&self, other: &Rhs) -> bool

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

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

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

fn ge(&self, other: &Rhs) -> bool

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

impl Copy for Opcode

impl Eq for Opcode

impl StructuralPartialEq for Opcode