Struct EntryOptions

#[repr(transparent)]
pub struct EntryOptions(u16);

Represents the options field of an IDT entry.

Tuple Fields

0: u16

Implementations

impl EntryOptions

const STACK_IDX_BITS: usize = 3usize

const STACK_IDX_OFFSET: usize = 0usize

const GATE_BITS: usize = 3usize

const GATE_OFFSET: usize = 8usize

const GATE_32_BITS: usize = 1usize

const GATE_32_OFFSET: usize = 11usize

const PRIVILEGE_LEVEL_BITS: usize = 2usize

const PRIVILEGE_LEVEL_OFFSET: usize = 13usize

const PRESENT_BITS: usize = 1usize

const PRESENT_OFFSET: usize = 15usize

pub const fn new() -> Self

Creates a new default initialized bitfield.

pub const fn from_bits(bits: u16) -> Self

Convert from bits.

pub const fn into_bits(self) -> u16

Convert into bits.

const fn stack_idx(&self) -> u16

Index of an interrupt stack

Bits: 0..3

const fn with_stack_idx_checked(self, value: u16) -> Result<Self, ()>

Index of an interrupt stack

Bits: 0..3

const fn with_stack_idx(self, value: u16) -> Self

Index of an interrupt stack

Bits: 0..3

fn set_stack_idx(&mut self, value: u16)

Index of an interrupt stack

Bits: 0..3

fn set_stack_idx_checked(&mut self, value: u16) -> Result<(), ()>

Index of an interrupt stack

Bits: 0..3

pub const fn gate(&self) -> Gate

Gate type

Bits: 8..11

pub const fn with_gate_checked(self, value: Gate) -> Result<Self, ()>

Gate type

Bits: 8..11

pub const fn with_gate(self, value: Gate) -> Self

Gate type

Bits: 8..11

pub fn set_gate(&mut self, value: Gate)

Gate type

Bits: 8..11

pub fn set_gate_checked(&mut self, value: Gate) -> Result<(), ()>

Gate type

Bits: 8..11

pub const fn gate_32(&self) -> bool

If this is a 32 bit entry

Bits: 11..12

pub const fn with_gate_32_checked(self, value: bool) -> Result<Self, ()>

If this is a 32 bit entry

Bits: 11..12

pub const fn with_gate_32(self, value: bool) -> Self

If this is a 32 bit entry

Bits: 11..12

pub fn set_gate_32(&mut self, value: bool)

If this is a 32 bit entry

Bits: 11..12

pub fn set_gate_32_checked(&mut self, value: bool) -> Result<(), ()>

If this is a 32 bit entry

Bits: 11..12

pub const fn privilege_level(&self) -> Ring

Set the required privilege level (DPL) for invoking the handler. The DPL can be 0 or 3, the default is 0. If CPL < DPL, a general protection fault occurs.

Bits: 13..15

pub const fn with_privilege_level_checked(self, value: Ring) -> Result<Self, ()>

Set the required privilege level (DPL) for invoking the handler. The DPL can be 0 or 3, the default is 0. If CPL < DPL, a general protection fault occurs.

Bits: 13..15

pub const fn with_privilege_level(self, value: Ring) -> Self

Set the required privilege level (DPL) for invoking the handler. The DPL can be 0 or 3, the default is 0. If CPL < DPL, a general protection fault occurs.

Bits: 13..15

pub fn set_privilege_level(&mut self, value: Ring)

Set the required privilege level (DPL) for invoking the handler. The DPL can be 0 or 3, the default is 0. If CPL < DPL, a general protection fault occurs.

Bits: 13..15

pub fn set_privilege_level_checked(&mut self, value: Ring) -> Result<(), ()>

Set the required privilege level (DPL) for invoking the handler. The DPL can be 0 or 3, the default is 0. If CPL < DPL, a general protection fault occurs.

Bits: 13..15

pub const fn present(&self) -> bool

Has to be true for valid entries.

Bits: 15..16

pub const fn with_present_checked(self, value: bool) -> Result<Self, ()>

Has to be true for valid entries.

Bits: 15..16

pub const fn with_present(self, value: bool) -> Self

Has to be true for valid entries.

Bits: 15..16

pub fn set_present(&mut self, value: bool)

Has to be true for valid entries.

Bits: 15..16

pub fn set_present_checked(&mut self, value: bool) -> Result<(), ()>

Has to be true for valid entries.

Bits: 15..16

impl EntryOptions

const fn minimal() -> Self

Creates a minimal options field with all the must-be-one bits set.

pub const unsafe fn with_stack(self, index: u16) -> Self

Assigns a Interrupt Stack Table (IST) stack to this handler. The CPU will then always switch to the specified stack before the handler is invoked. This allows kernels to recover from corrupt stack pointers (e.g., on kernel stack overflow).

An IST stack is specified by an IST index between 0 and 6 (inclusive). Using the same stack for multiple interrupts can be dangerous when nested interrupts are possible.

This function panics if the index is not in the range 0..7.

Safety

This function is unsafe because the caller must ensure that the passed stack index is valid and not used by other interrupts. Otherwise, memory safety violations are possible.

Trait Implementations

impl Clone for EntryOptions

fn clone(&self) -> EntryOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EntryOptions

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

Formats the value using the given formatter.

impl Default for EntryOptions

fn default() -> Self

Returns the “default value” for a type.

impl From<EntryOptions> for u16

fn from(v: EntryOptions) -> u16

Converts to this type from the input type.

impl From<u16> for EntryOptions

fn from(v: u16) -> Self

Converts to this type from the input type.

impl PartialEq for EntryOptions

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for EntryOptions

impl Eq for EntryOptions

impl StructuralPartialEq for EntryOptions