Struct rustc_middle::middle::codegen_fn_attrs::CodegenFnAttrFlags

pub struct CodegenFnAttrFlags {
    bits: u32,
}

Fields

bits: u32

Implementations

impl CodegenFnAttrFlags

pub const COLD: Self = _

#[cold]: a hint to LLVM that this function, when called, is never on the hot path.

pub const ALLOCATOR: Self = _

#[rustc_allocator]: a hint to LLVM that the pointer returned from this function is never null and the function has no side effects other than allocating.

pub const NEVER_UNWIND: Self = _

An indicator that function will never unwind. Will become obsolete once C-unwind is fully stabilized.

pub const NAKED: Self = _

#[naked]: an indicator to LLVM that no function prologue/epilogue should be generated.

pub const NO_MANGLE: Self = _

#[no_mangle]: an indicator that the function’s name should be the same as its symbol.

pub const RUSTC_STD_INTERNAL_SYMBOL: Self = _

#[rustc_std_internal_symbol]: an indicator that this symbol is a “weird symbol” for the standard library in that it has slightly different linkage, visibility, and reachability rules.

pub const THREAD_LOCAL: Self = _

#[thread_local]: indicates a static is actually a thread local piece of memory

pub const USED: Self = _

#[used]: indicates that LLVM can’t eliminate this function (but the linker can!).

pub const FFI_RETURNS_TWICE: Self = _

#[ffi_returns_twice], indicates that an extern function can return multiple times

pub const TRACK_CALLER: Self = _

#[track_caller]: allow access to the caller location

pub const FFI_PURE: Self = _

#[ffi_pure]: applies clang’s pure attribute to a foreign function declaration.

pub const FFI_CONST: Self = _

#[ffi_const]: applies clang’s const attribute to a foreign function declaration.

pub const CMSE_NONSECURE_ENTRY: Self = _

#[cmse_nonsecure_entry]: with a TrustZone-M extension, declare a function as an entry function from Non-Secure code.

pub const NO_COVERAGE: Self = _

#[no_coverage]: indicates that the function should be ignored by the MIR InstrumentCoverage pass and not added to the coverage map during codegen.

pub const USED_LINKER: Self = _

#[used(linker)]: indicates that LLVM nor the linker can eliminate this function.

pub const DEALLOCATOR: Self = _

#[rustc_deallocator]: a hint to LLVM that the function only deallocates memory.

pub const REALLOCATOR: Self = _

#[rustc_reallocator]: a hint to LLVM that the function only reallocates memory.

pub const ALLOCATOR_ZEROED: Self = _

#[rustc_allocator_zeroed]: a hint to LLVM that the function only allocates zeroed memory.

pub const fn empty() -> Self

Returns an empty set of flags.

pub const fn all() -> Self

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u32) -> Option<Self>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> Self

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> 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.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Self) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: Self) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: Self)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Self)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Self)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Self, value: bool)

Inserts or removes the specified flags depending on the passed value.

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.

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.

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.

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.

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

impl Binary for CodegenFnAttrFlags

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

Formats the value using the given formatter.

impl BitAnd<CodegenFnAttrFlags> for CodegenFnAttrFlags

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

Returns the intersection between the two sets of flags.

type Output = CodegenFnAttrFlags

The resulting type after applying the & operator.

impl BitAndAssign<CodegenFnAttrFlags> for CodegenFnAttrFlags

fn bitand_assign(&mut self, other: Self)

Disables all flags disabled in the set.

impl BitOr<CodegenFnAttrFlags> for CodegenFnAttrFlags

fn bitor(self, other: CodegenFnAttrFlags) -> Self

Returns the union of the two sets of flags.

type Output = CodegenFnAttrFlags

The resulting type after applying the | operator.

impl BitOrAssign<CodegenFnAttrFlags> for CodegenFnAttrFlags

fn bitor_assign(&mut self, other: Self)

Adds the set of flags.

impl BitXor<CodegenFnAttrFlags> for CodegenFnAttrFlags

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

Returns the left flags, but with all the right flags toggled.

type Output = CodegenFnAttrFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<CodegenFnAttrFlags> for CodegenFnAttrFlags

fn bitxor_assign(&mut self, other: Self)

Toggles the set of flags.

impl Clone for CodegenFnAttrFlags

fn clone(&self) -> CodegenFnAttrFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CodegenFnAttrFlags

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

Formats the value using the given formatter.

impl<'tcx, __D: TyDecoder<I = TyCtxt<'tcx>>> Decodable<__D> for CodegenFnAttrFlags

fn decode(__decoder: &mut __D) -> Self

impl<'tcx, __E: TyEncoder<I = TyCtxt<'tcx>>> Encodable<__E> for CodegenFnAttrFlags

fn encode(&self, __encoder: &mut __E)

impl Extend<CodegenFnAttrFlags> for CodegenFnAttrFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<CodegenFnAttrFlags> for CodegenFnAttrFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

Creates a value from an iterator.

impl Hash for CodegenFnAttrFlags

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<'__ctx> HashStable<StableHashingContext<'__ctx>> for CodegenFnAttrFlags

fn hash_stable(
    &self,
    __hcx: &mut StableHashingContext<'__ctx>,
    __hasher: &mut StableHasher
)

impl LowerHex for CodegenFnAttrFlags

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

Formats the value using the given formatter.

impl Not for CodegenFnAttrFlags

fn not(self) -> Self

Returns the complement of this set of flags.

type Output = CodegenFnAttrFlags

The resulting type after applying the ! operator.

impl Octal for CodegenFnAttrFlags

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

Formats the value using the given formatter.

impl Ord for CodegenFnAttrFlags

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<CodegenFnAttrFlags> for CodegenFnAttrFlags

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

fn partial_cmp(&self, other: &CodegenFnAttrFlags) -> 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 Sub<CodegenFnAttrFlags> for CodegenFnAttrFlags

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

Returns the set difference of the two sets of flags.

type Output = CodegenFnAttrFlags

The resulting type after applying the - operator.

impl SubAssign<CodegenFnAttrFlags> for CodegenFnAttrFlags

fn sub_assign(&mut self, other: Self)

Disables all flags enabled in the set.

impl UpperHex for CodegenFnAttrFlags

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

Formats the value using the given formatter.

impl Copy for CodegenFnAttrFlags

impl Eq for CodegenFnAttrFlags

impl StructuralEq for CodegenFnAttrFlags

impl StructuralPartialEq for CodegenFnAttrFlags

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: 4 bytes