Struct hal_x86_64::segment::Descriptor

pub struct Descriptor(/* private fields */);

A 64-bit mode user segment descriptor.

A segment descriptor is an entry in a GDT or LDT that provides the processor with the size and location of a segment, as well as access control and status information.

Refer to section 3.4.5 in Vol. 3A of the Intel® 64 and IA-32 Architectures Developer’s Manual for details.

Implementations

impl Descriptor

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

Constructs a new instance of Self from the provided raw bits.

pub const fn new() -> Self

Constructs a new instance of Self with all bits set to 0.

pub const fn bits(self) -> u64

Returns the raw bit representatiion of self as an integer.

pub fn with<T>(self, field: Pack64<T, Self>, value: T) -> Self

where T: FromBits<u64>,

Packs the bit representation of value into self at the bit range designated by field, returning a new bitfield.

pub fn set<T>(&mut self, field: Pack64<T, Self>, value: T) -> &mut Self

where T: FromBits<u64>,

Packs the bit representation of value into self at the range designated by field, mutating self in place.

pub fn get<T>(self, field: Pack64<T, Self>) -> T

where T: FromBits<u64>,

Unpacks the bit range represented by field from self, and converts it into a T-typed value.

Panics

This method panics if self does not contain a valid bit pattern for a T-typed value, as determined by T’s FromBits::try_from_bits implementation.

pub fn try_get<T>(self, field: Pack64<T, Self>) -> Result<T, T::Error>

where T: FromBits<u64>,

Unpacks the bit range represented by field from self and attempts to convert it into a T-typed value.

Returns

• Ok(T) if a T-typed value could be constructed from the bits in src
• Err(T::Error) if src does not contain a valid bit pattern for a T-typed value, as determined by T’s [FromBits::try_from_bits implementation.

pub fn assert_valid()

Asserts that all the packing specs for this type are valid.

This is intended to be used in unit tests.

pub fn display_ascii(&self) -> impl Display

Returns a value that formats this bitfield in a multi-line format, using only ASCII characters.

This is equivalent to formatting this bitfield using a {} display specifier, but will never use Unicode box-drawing characters, even when an upstream formatter uses the {:#} fmt::Display specifier. This is intended for use on platforms where Unicode box drawing characters are never available.

pub fn display_unicode(&self) -> impl Display

Returns a value that formats this bitfield in a multi-line format, always using Unicode box-drawing characters.

This is equivalent to formatting this bitfield using a {:#} format specifier, but will always use Unicode box-drawing characters, even when an upstream formatter uses the {} fmt::Display specifier.

impl Descriptor

pub const fn code() -> Self

Returns a new segment descriptor for a 64-bit code segment.

pub const fn code_32() -> Self

Returns a new segment descriptor for a 32-bit code segment.

pub const fn data() -> Self

Returns a new segment descriptor for data segment.

pub fn ring(&self) -> Ring

pub const fn limit(&self) -> u64

pub const fn base(&self) -> u64

pub const fn with_ring(self, ring: Ring) -> Self

Trait Implementations

impl Binary for Descriptor

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

Formats the value using the given formatter.

impl Clone for Descriptor

fn clone(&self) -> Descriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Descriptor

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

Formats the value using the given formatter.

impl Display for Descriptor

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

Formats the value using the given formatter.

impl From<Descriptor> for u64

fn from(Descriptor: Descriptor) -> Self

Converts to this type from the input type.

impl From<u64> for Descriptor

fn from(val: u64) -> Self

Converts to this type from the input type.

impl LowerHex for Descriptor

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

Formats the value using the given formatter.

impl PartialEq for Descriptor

fn eq(&self, other: &Descriptor) -> 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 UpperHex for Descriptor

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

Formats the value using the given formatter.

impl Copy for Descriptor

impl Eq for Descriptor

impl StructuralEq for Descriptor

impl StructuralPartialEq for Descriptor