Struct stivale_boot::v1::StivaleHeaderFlags
source · [−]pub struct StivaleHeaderFlags { /* private fields */ }
Implementations
sourceimpl StivaleHeaderFlags
impl StivaleHeaderFlags
sourcepub const FRAMEBUFFER_MODE: Self = Self{bits: 1 << 0,}
pub const FRAMEBUFFER_MODE: Self = Self{bits: 1 << 0,}
If set, the bootloader will be instructed to use graphics framebuffer mode. Else text mode will be selected.
sourcepub const LEVEL_5_PAGING: Self = Self{bits: 1 << 1,}
pub const LEVEL_5_PAGING: Self = Self{bits: 1 << 1,}
If set, level 5 paging will be requested to the bootloader (only if avaliable). Else standard level 4 paging will be used.
32-bit
This bit is ignored for 32-bit kernels.
sourcepub const KASLR: Self = Self{bits: 1 << 2,}
pub const KASLR: Self = Self{bits: 1 << 2,}
Formerly used to indicate whether to enable KASLR, this flag is now reserved as KASLR is enabled in the bootloader configuration instead. Presently reserved and unused.
sourcepub const HIGHER_HALF: Self = Self{bits: 1 << 3,}
pub const HIGHER_HALF: Self = Self{bits: 1 << 3,}
If set, all pointers, except otherwise noted,
are to be offset to the higher half. That is,
their value will be their physical address plus
0xffff800000000000
with 4-level paging or
0xff00000000000000
with 5-level paging on x86_64.
Success for this feature can be tested by checking
whether the stivale struct pointer argument passed
to the entry point function is in the higher
half or not.
pub const NULL: Self = Self{bits: 0,}
sourcepub const fn from_bits(bits: u16) -> Option<Self>
pub const fn from_bits(bits: u16) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u16) -> Self
pub const fn from_bits_truncate(bits: u16) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u16) -> Self
pub const unsafe fn from_bits_unchecked(bits: u16) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations
sourceimpl Binary for StivaleHeaderFlags
impl Binary for StivaleHeaderFlags
sourceimpl BitAnd<StivaleHeaderFlags> for StivaleHeaderFlags
impl BitAnd<StivaleHeaderFlags> for StivaleHeaderFlags
type Output = StivaleHeaderFlags
type Output = StivaleHeaderFlags
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<StivaleHeaderFlags> for StivaleHeaderFlags
impl BitAndAssign<StivaleHeaderFlags> for StivaleHeaderFlags
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<StivaleHeaderFlags> for StivaleHeaderFlags
impl BitOr<StivaleHeaderFlags> for StivaleHeaderFlags
sourcefn bitor(self, other: StivaleHeaderFlags) -> Self
fn bitor(self, other: StivaleHeaderFlags) -> Self
Returns the union of the two sets of flags.
type Output = StivaleHeaderFlags
type Output = StivaleHeaderFlags
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<StivaleHeaderFlags> for StivaleHeaderFlags
impl BitOrAssign<StivaleHeaderFlags> for StivaleHeaderFlags
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<StivaleHeaderFlags> for StivaleHeaderFlags
impl BitXor<StivaleHeaderFlags> for StivaleHeaderFlags
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = StivaleHeaderFlags
type Output = StivaleHeaderFlags
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<StivaleHeaderFlags> for StivaleHeaderFlags
impl BitXorAssign<StivaleHeaderFlags> for StivaleHeaderFlags
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for StivaleHeaderFlags
impl Clone for StivaleHeaderFlags
sourcefn clone(&self) -> StivaleHeaderFlags
fn clone(&self) -> StivaleHeaderFlags
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for StivaleHeaderFlags
impl Debug for StivaleHeaderFlags
sourceimpl Extend<StivaleHeaderFlags> for StivaleHeaderFlags
impl Extend<StivaleHeaderFlags> for StivaleHeaderFlags
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<StivaleHeaderFlags> for StivaleHeaderFlags
impl FromIterator<StivaleHeaderFlags> for StivaleHeaderFlags
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Hash for StivaleHeaderFlags
impl Hash for StivaleHeaderFlags
sourceimpl LowerHex for StivaleHeaderFlags
impl LowerHex for StivaleHeaderFlags
sourceimpl Not for StivaleHeaderFlags
impl Not for StivaleHeaderFlags
type Output = StivaleHeaderFlags
type Output = StivaleHeaderFlags
The resulting type after applying the !
operator.
sourceimpl Octal for StivaleHeaderFlags
impl Octal for StivaleHeaderFlags
sourceimpl Ord for StivaleHeaderFlags
impl Ord for StivaleHeaderFlags
sourceimpl PartialEq<StivaleHeaderFlags> for StivaleHeaderFlags
impl PartialEq<StivaleHeaderFlags> for StivaleHeaderFlags
sourcefn eq(&self, other: &StivaleHeaderFlags) -> bool
fn eq(&self, other: &StivaleHeaderFlags) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &StivaleHeaderFlags) -> bool
fn ne(&self, other: &StivaleHeaderFlags) -> bool
This method tests for !=
.
sourceimpl PartialOrd<StivaleHeaderFlags> for StivaleHeaderFlags
impl PartialOrd<StivaleHeaderFlags> for StivaleHeaderFlags
sourcefn partial_cmp(&self, other: &StivaleHeaderFlags) -> Option<Ordering>
fn partial_cmp(&self, other: &StivaleHeaderFlags) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Sub<StivaleHeaderFlags> for StivaleHeaderFlags
impl Sub<StivaleHeaderFlags> for StivaleHeaderFlags
type Output = StivaleHeaderFlags
type Output = StivaleHeaderFlags
The resulting type after applying the -
operator.
sourceimpl SubAssign<StivaleHeaderFlags> for StivaleHeaderFlags
impl SubAssign<StivaleHeaderFlags> for StivaleHeaderFlags
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for StivaleHeaderFlags
impl UpperHex for StivaleHeaderFlags
impl Copy for StivaleHeaderFlags
impl Eq for StivaleHeaderFlags
impl StructuralEq for StivaleHeaderFlags
impl StructuralPartialEq for StivaleHeaderFlags
Auto Trait Implementations
impl RefUnwindSafe for StivaleHeaderFlags
impl Send for StivaleHeaderFlags
impl Sync for StivaleHeaderFlags
impl Unpin for StivaleHeaderFlags
impl UnwindSafe for StivaleHeaderFlags
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more