Struct rustc_target::spec::LinkerFeatures
source · pub struct LinkerFeatures(InternalBitFlags);
Expand description
The -Z linker-features
components that can individually be enabled or disabled.
They are feature flags intended to be a more flexible mechanism than linker flavors, and also to prevent a combinatorial explosion of flavors whenever a new linker feature is required. These flags are “generic”, in the sense that they can work on multiple targets on the CLI. Otherwise, one would have to select different linkers flavors for each target.
Here are some examples of the advantages they offer:
- default feature sets for principal flavors, or for specific targets.
- flavor-specific features: for example, clang offers automatic cross-linking with
--target
, which gcc-style compilers don’t support. The flavor is still a C/C++ compiler, and we don’t need to multiply the number of flavors for this use-case. Instead, we can have a single+target
feature. - umbrella features: for example if clang accumulates more features in the future than just
the
+target
above. That could be modeled as+clang
. - niche features for resolving specific issues: for example, on Apple targets the linker
flag implementing the
as-needed
native link modifier (#99424) is only possible on sufficiently recent linker versions. - still allows for discovery and automation, for example via feature detection. This can be useful in exotic environments/build systems.
Tuple Fields§
§0: InternalBitFlags
Implementations§
source§impl LinkerFeatures
impl LinkerFeatures
sourcepub const fn bits(&self) -> u8
pub const fn bits(&self) -> u8
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u8) -> Self
pub const fn from_bits_retain(bits: u8) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl LinkerFeatures
impl LinkerFeatures
sourcepub const fn iter(&self) -> Iter<LinkerFeatures>
pub const fn iter(&self) -> Iter<LinkerFeatures>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
sourcepub const fn iter_names(&self) -> IterNames<LinkerFeatures>
pub const fn iter_names(&self) -> IterNames<LinkerFeatures>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
source§impl LinkerFeatures
impl LinkerFeatures
sourcepub fn from_str(s: &str) -> Option<LinkerFeatures>
pub fn from_str(s: &str) -> Option<LinkerFeatures>
Parses a single -Z linker-features
well-known feature, not a set of flags.
sourcepub fn is_lld_enabled(self) -> bool
pub fn is_lld_enabled(self) -> bool
Returns whether the lld
linker feature is enabled.
sourcepub fn is_cc_enabled(self) -> bool
pub fn is_cc_enabled(self) -> bool
Returns whether the cc
linker feature is enabled.
Trait Implementations§
source§impl Binary for LinkerFeatures
impl Binary for LinkerFeatures
source§impl BitAnd for LinkerFeatures
impl BitAnd for LinkerFeatures
source§impl BitAndAssign for LinkerFeatures
impl BitAndAssign for LinkerFeatures
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOr for LinkerFeatures
impl BitOr for LinkerFeatures
source§fn bitor(self, other: LinkerFeatures) -> Self
fn bitor(self, other: LinkerFeatures) -> Self
The bitwise or (|
) of the bits in two flags values.
§type Output = LinkerFeatures
type Output = LinkerFeatures
|
operator.source§impl BitOrAssign for LinkerFeatures
impl BitOrAssign for LinkerFeatures
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXor for LinkerFeatures
impl BitXor for LinkerFeatures
source§impl BitXorAssign for LinkerFeatures
impl BitXorAssign for LinkerFeatures
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl Clone for LinkerFeatures
impl Clone for LinkerFeatures
source§fn clone(&self) -> LinkerFeatures
fn clone(&self) -> LinkerFeatures
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for LinkerFeatures
impl Debug for LinkerFeatures
source§impl Default for LinkerFeatures
impl Default for LinkerFeatures
source§fn default() -> LinkerFeatures
fn default() -> LinkerFeatures
source§impl Extend<LinkerFeatures> for LinkerFeatures
impl Extend<LinkerFeatures> for LinkerFeatures
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl Flags for LinkerFeatures
impl Flags for LinkerFeatures
source§const FLAGS: &'static [Flag<LinkerFeatures>] = _
const FLAGS: &'static [Flag<LinkerFeatures>] = _
source§fn from_bits_retain(bits: u8) -> LinkerFeatures
fn from_bits_retain(bits: u8) -> LinkerFeatures
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<LinkerFeatures> for LinkerFeatures
impl FromIterator<LinkerFeatures> for LinkerFeatures
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl IntoIterator for LinkerFeatures
impl IntoIterator for LinkerFeatures
source§impl LowerHex for LinkerFeatures
impl LowerHex for LinkerFeatures
source§impl Not for LinkerFeatures
impl Not for LinkerFeatures
source§impl Octal for LinkerFeatures
impl Octal for LinkerFeatures
source§impl PartialEq for LinkerFeatures
impl PartialEq for LinkerFeatures
source§fn eq(&self, other: &LinkerFeatures) -> bool
fn eq(&self, other: &LinkerFeatures) -> bool
self
and other
values to be equal, and is used
by ==
.source§impl PublicFlags for LinkerFeatures
impl PublicFlags for LinkerFeatures
source§impl Sub for LinkerFeatures
impl Sub for LinkerFeatures
source§fn sub(self, other: Self) -> Self
fn sub(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
§type Output = LinkerFeatures
type Output = LinkerFeatures
-
operator.source§impl SubAssign for LinkerFeatures
impl SubAssign for LinkerFeatures
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
source§impl UpperHex for LinkerFeatures
impl UpperHex for LinkerFeatures
impl Copy for LinkerFeatures
impl Eq for LinkerFeatures
impl StructuralPartialEq for LinkerFeatures
Auto Trait Implementations§
impl Freeze for LinkerFeatures
impl RefUnwindSafe for LinkerFeatures
impl Send for LinkerFeatures
impl Sync for LinkerFeatures
impl Unpin for LinkerFeatures
impl UnwindSafe for LinkerFeatures
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Copy,
impl<T> CloneToUninit for Twhere
T: Copy,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
impl<'a, T> Captures<'a> for Twhere
T: ?Sized,
Layout§
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...)
attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.
Size: 1 byte