Skip to main content

Attribute

Enum Attribute 

Source
pub enum Attribute {
    Opaque,
    Exclude,
    Rename(String),
    VariantsPrefix(String),
    VariantsSuffix(String),
    Transparent,
    IsContract {
        kind: String,
        target: MaybeAssocItemId,
    },
    HasContract {
        kind: String,
        contract: FunDeclId,
    },
    DocComment(String),
    Builtin(AttributeKind),
    Unknown(RawAttribute),
}
Expand description

Attributes (#[...]).

Variants§

§

Opaque

Do not translate the body of this item. Written #[charon::opaque]

§

Exclude

Do not translate this item at all. Written #[charon::exclude]

§

Rename(String)

Provide a new name that consumers of the llbc can use. Written #[charon::rename("new_name")]

§

VariantsPrefix(String)

For enums only: rename the variants by pre-pending their names with the given prefix. Written #[charon::variants_prefix("prefix_")].

§

VariantsSuffix(String)

Same as VariantsPrefix, but appends to the name instead of pre-pending.

§

Transparent

The structure is treated as a transparent wrapper around its sole field. Written #[charon::transparent].

§

IsContract

An item annotated with #[charon::contract(kind = "...", parent)] or #[charon::contract(kind = "...", for = "...")]. This makes it a contract for the target item.

Fields

§kind: String
§

HasContract

An item that has a contract that applies to it. The referenced item is the function that specifies the contract.

Fields

§kind: String
§contract: FunDeclId
§

DocComment(String)

A doc-comment such as /// ....

§

Builtin(AttributeKind)

A built-in attribute.

§

Unknown(RawAttribute)

None of the above.

Implementations§

Source§

impl Attribute

Source

pub fn is_opaque(&self) -> bool

Returns true if this is a Attribute::Opaque, otherwise false

Source

pub fn is_exclude(&self) -> bool

Returns true if this is a Attribute::Exclude, otherwise false

Source

pub fn is_rename(&self) -> bool

Returns true if this is a Attribute::Rename, otherwise false

Source

pub fn as_rename_mut(&mut self) -> Option<&mut String>

Optionally returns mutable references to the inner fields if this is a Attribute::Rename, otherwise None

Source

pub fn as_rename(&self) -> Option<&String>

Optionally returns references to the inner fields if this is a Attribute::Rename, otherwise None

Source

pub fn into_rename(self) -> Result<String, Self>

Returns the inner fields if this is a Attribute::Rename, otherwise returns back the enum in the Err case of the result

Source

pub unsafe fn into_rename_unchecked(self) -> String

Unchecked return of the inner fields of Attribute::Rename.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub unsafe fn as_rename_unchecked(&self) -> &String

Unchecked reference of the inner fields of Attribute::Rename.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub unsafe fn as_rename_mut_unchecked(&mut self) -> &mut String

Unchecked mutable reference of the inner fields of Attribute::Rename.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub fn is_variants_prefix(&self) -> bool

Returns true if this is a Attribute::VariantsPrefix, otherwise false

Source

pub fn as_variants_prefix_mut(&mut self) -> Option<&mut String>

Optionally returns mutable references to the inner fields if this is a Attribute::VariantsPrefix, otherwise None

Source

pub fn as_variants_prefix(&self) -> Option<&String>

Optionally returns references to the inner fields if this is a Attribute::VariantsPrefix, otherwise None

Source

pub fn into_variants_prefix(self) -> Result<String, Self>

Returns the inner fields if this is a Attribute::VariantsPrefix, otherwise returns back the enum in the Err case of the result

Source

pub unsafe fn into_variants_prefix_unchecked(self) -> String

Unchecked return of the inner fields of Attribute::VariantsPrefix.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub unsafe fn as_variants_prefix_unchecked(&self) -> &String

Unchecked reference of the inner fields of Attribute::VariantsPrefix.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub unsafe fn as_variants_prefix_mut_unchecked(&mut self) -> &mut String

Unchecked mutable reference of the inner fields of Attribute::VariantsPrefix.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub fn is_variants_suffix(&self) -> bool

Returns true if this is a Attribute::VariantsSuffix, otherwise false

Source

pub fn as_variants_suffix_mut(&mut self) -> Option<&mut String>

Optionally returns mutable references to the inner fields if this is a Attribute::VariantsSuffix, otherwise None

Source

pub fn as_variants_suffix(&self) -> Option<&String>

Optionally returns references to the inner fields if this is a Attribute::VariantsSuffix, otherwise None

Source

pub fn into_variants_suffix(self) -> Result<String, Self>

Returns the inner fields if this is a Attribute::VariantsSuffix, otherwise returns back the enum in the Err case of the result

Source

pub unsafe fn into_variants_suffix_unchecked(self) -> String

Unchecked return of the inner fields of Attribute::VariantsSuffix.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub unsafe fn as_variants_suffix_unchecked(&self) -> &String

Unchecked reference of the inner fields of Attribute::VariantsSuffix.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub unsafe fn as_variants_suffix_mut_unchecked(&mut self) -> &mut String

Unchecked mutable reference of the inner fields of Attribute::VariantsSuffix.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub fn is_transparent(&self) -> bool

Returns true if this is a Attribute::Transparent, otherwise false

Source

pub fn is_is_contract(&self) -> bool

Returns true if this is a Attribute::IsContract, otherwise false

Source

pub fn as_is_contract_mut( &mut self, ) -> Option<(&mut String, &mut MaybeAssocItemId)>

Optionally returns mutable references to the inner fields if this is a Attribute::IsContract, otherwise None

Source

pub fn as_is_contract(&self) -> Option<(&String, &MaybeAssocItemId)>

Optionally returns references to the inner fields if this is a Attribute::IsContract, otherwise None

Source

pub fn into_is_contract(self) -> Result<(String, MaybeAssocItemId), Self>

Returns the inner fields if this is a Attribute::IsContract, otherwise returns back the enum in the Err case of the result

Source

pub unsafe fn into_is_contract_unchecked(self) -> (String, MaybeAssocItemId)

Unchecked return of the inner fields of Attribute::IsContract.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub unsafe fn as_is_contract_unchecked(&self) -> (&String, &MaybeAssocItemId)

Unchecked reference of the inner fields of Attribute::IsContract.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub unsafe fn as_is_contract_mut_unchecked( &mut self, ) -> (&mut String, &mut MaybeAssocItemId)

Unchecked mutable reference of the inner fields of Attribute::IsContract.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub fn is_has_contract(&self) -> bool

Returns true if this is a Attribute::HasContract, otherwise false

Source

pub fn as_has_contract_mut(&mut self) -> Option<(&mut String, &mut FunDeclId)>

Optionally returns mutable references to the inner fields if this is a Attribute::HasContract, otherwise None

Source

pub fn as_has_contract(&self) -> Option<(&String, &FunDeclId)>

Optionally returns references to the inner fields if this is a Attribute::HasContract, otherwise None

Source

pub fn into_has_contract(self) -> Result<(String, FunDeclId), Self>

Returns the inner fields if this is a Attribute::HasContract, otherwise returns back the enum in the Err case of the result

Source

pub unsafe fn into_has_contract_unchecked(self) -> (String, FunDeclId)

Unchecked return of the inner fields of Attribute::HasContract.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub unsafe fn as_has_contract_unchecked(&self) -> (&String, &FunDeclId)

Unchecked reference of the inner fields of Attribute::HasContract.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub unsafe fn as_has_contract_mut_unchecked( &mut self, ) -> (&mut String, &mut FunDeclId)

Unchecked mutable reference of the inner fields of Attribute::HasContract.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub fn is_doc_comment(&self) -> bool

Returns true if this is a Attribute::DocComment, otherwise false

Source

pub fn as_doc_comment_mut(&mut self) -> Option<&mut String>

Optionally returns mutable references to the inner fields if this is a Attribute::DocComment, otherwise None

Source

pub fn as_doc_comment(&self) -> Option<&String>

Optionally returns references to the inner fields if this is a Attribute::DocComment, otherwise None

Source

pub fn into_doc_comment(self) -> Result<String, Self>

Returns the inner fields if this is a Attribute::DocComment, otherwise returns back the enum in the Err case of the result

Source

pub unsafe fn into_doc_comment_unchecked(self) -> String

Unchecked return of the inner fields of Attribute::DocComment.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub unsafe fn as_doc_comment_unchecked(&self) -> &String

Unchecked reference of the inner fields of Attribute::DocComment.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub unsafe fn as_doc_comment_mut_unchecked(&mut self) -> &mut String

Unchecked mutable reference of the inner fields of Attribute::DocComment.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub fn is_builtin(&self) -> bool

Returns true if this is a Attribute::Builtin, otherwise false

Source

pub fn as_builtin_mut(&mut self) -> Option<&mut AttributeKind>

Optionally returns mutable references to the inner fields if this is a Attribute::Builtin, otherwise None

Source

pub fn as_builtin(&self) -> Option<&AttributeKind>

Optionally returns references to the inner fields if this is a Attribute::Builtin, otherwise None

Source

pub fn into_builtin(self) -> Result<AttributeKind, Self>

Returns the inner fields if this is a Attribute::Builtin, otherwise returns back the enum in the Err case of the result

Source

pub unsafe fn into_builtin_unchecked(self) -> AttributeKind

Unchecked return of the inner fields of Attribute::Builtin.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub unsafe fn as_builtin_unchecked(&self) -> &AttributeKind

Unchecked reference of the inner fields of Attribute::Builtin.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub unsafe fn as_builtin_mut_unchecked(&mut self) -> &mut AttributeKind

Unchecked mutable reference of the inner fields of Attribute::Builtin.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub fn is_unknown(&self) -> bool

Returns true if this is a Attribute::Unknown, otherwise false

Source

pub fn as_unknown_mut(&mut self) -> Option<&mut RawAttribute>

Optionally returns mutable references to the inner fields if this is a Attribute::Unknown, otherwise None

Source

pub fn as_unknown(&self) -> Option<&RawAttribute>

Optionally returns references to the inner fields if this is a Attribute::Unknown, otherwise None

Source

pub fn into_unknown(self) -> Result<RawAttribute, Self>

Returns the inner fields if this is a Attribute::Unknown, otherwise returns back the enum in the Err case of the result

Source

pub unsafe fn into_unknown_unchecked(self) -> RawAttribute

Unchecked return of the inner fields of Attribute::Unknown.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub unsafe fn as_unknown_unchecked(&self) -> &RawAttribute

Unchecked reference of the inner fields of Attribute::Unknown.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source

pub unsafe fn as_unknown_mut_unchecked(&mut self) -> &mut RawAttribute

Unchecked mutable reference of the inner fields of Attribute::Unknown.

§Safety

Results in undefined behavior when it is the incorrect variant.

Source§

impl Attribute

Source

pub fn is_unsafe_to_apply(&self) -> bool

Whether this attribute is unsafe to apply (safety.unsafe-attribute), as listed in attributes.safety (https://doc.rust-lang.org/reference/attributes.html).

Source§

impl Attribute

Source

fn fmt_unindented<C: AstFormatter>(&self, ctx: &C, f: &mut impl Write) -> Result

Trait Implementations§

Source§

impl AstVisitable for Attribute

Source§

fn drive<V: VisitAst>(&self, v: &mut V) -> ControlFlow<V::Break>

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.
Source§

fn drive_mut<V: VisitAstMut>(&mut self, v: &mut V) -> ControlFlow<V::Break>

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.
Source§

fn drive_two<V: ZipAst>(&self, other: &Self, v: &mut V) -> ControlFlow<V::Break>

Recursively visit this type with the provided visitor. This calls the visitor’s visit_$any method if it exists, otherwise visit_inner.
Source§

fn name(&self) -> &'static str

The name of the type, used for debug logging.
Source§

fn dyn_visit<T: AstVisitable>(&self, f: impl FnMut(&T))
where Self: Sized,

Visit all occurrences of that type inside self, in pre-order traversal.
Source§

fn dyn_visit_mut<T: AstVisitable>(&mut self, f: impl FnMut(&mut T))
where Self: Sized,

Visit all occurrences of that type inside self, in pre-order traversal.
Source§

impl Clone for Attribute

Source§

fn clone(&self) -> Attribute

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Attribute

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for Attribute

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<'s, V> Drive<'s, V> for Attribute
where V: Visitor + Visit<'s, String> + Visit<'s, MaybeAssocItemId> + Visit<'s, FunDeclId> + Visit<'s, AttributeKind> + Visit<'s, RawAttribute>,

Source§

fn drive_inner(&'s self, visitor: &mut V) -> ControlFlow<V::Break>

Call v.visit() on the immediate contents of self.
Source§

impl<'s, V> DriveMut<'s, V> for Attribute
where V: Visitor + VisitMut<'s, String> + VisitMut<'s, MaybeAssocItemId> + VisitMut<'s, FunDeclId> + VisitMut<'s, AttributeKind> + VisitMut<'s, RawAttribute>,

Source§

fn drive_inner_mut(&'s mut self, visitor: &mut V) -> ControlFlow<V::Break>

Call v.visit() on the immediate contents of self.
Source§

impl<'s, V> DriveTwo<'s, V> for Attribute
where V: Visitor<Break: Default> + VisitTwo<'s, String> + VisitTwo<'s, MaybeAssocItemId> + VisitTwo<'s, FunDeclId> + VisitTwo<'s, AttributeKind> + VisitTwo<'s, RawAttribute>,

Source§

fn drive_two_inner( &'s self, other: &'s Self, visitor: &mut V, ) -> ControlFlow<V::Break>

Call v.visit() on the immediate contents of self and other, if they correspond. If the values don’t match up, this returns Break(Default::default()).
Source§

impl Eq for Attribute

Source§

impl<C: AstFormatter> FmtWithCtx<C> for Attribute

Source§

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

Source§

fn with_ctx<'a>(&'a self, ctx: &'a C) -> WithCtx<'a, C, Self>

Returns a struct that implements Display. This allows the following: Read more
Source§

fn to_string_with_ctx(&self, ctx: &C) -> String

Source§

impl PartialEq for Attribute

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for Attribute

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Attribute

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<T> Mappable for T
where T: Any + Send + Sync,

Source§

impl<T> MergeValue for T
where T: PartialEq + Debug,

Source§

fn merge(&mut self, other: T)

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> TyVisitable for T
where T: AstVisitable,

Source§

fn type_info(&self) -> TypeInfo

Compute various bits of information about the contents of this value. See methods on TypeInfo.
Source§

fn visit_vars(&mut self, v: &mut impl VarsVisitor)

Visit the variables contained in self, as seen from the outside of self. This means that any variable bound inside self will be skipped, and all the seen De Bruijn indices will count from the outside of self.
Source§

fn substitute(self, generics: &GenericArgs) -> Self

Substitute the generic variables inside self by replacing them with the provided values. Note: if self is an item that comes from a TraitDecl, you must use substitute_with_self or substitute_inner_binder, otherwise you’ll get panics.
Source§

fn substitute_inner_binder(self, generics: &GenericArgs) -> Self

Substitute the generic variables inside self by replacing them with the provided values. This is appropriate when substituting an inner binder.
Source§

fn substitute_explicits(self, generics: &GenericArgs) -> Self

Substitute only the type, region and const generic args.
Source§

fn substitute_with_self( self, generics: &GenericArgs, self_ref: &TraitRefKind, ) -> Self

Substitute the generic variables as well as the TraitRefKind::SelfId trait ref.
Source§

fn substitute_with_tref(self, tref: &TraitRef) -> Self

Substitute the generic variables as well as the TraitRefKind::SelfId trait ref.
Source§

fn try_substitute_with_tref( self, tref: &TraitRef, ) -> Result<Self, GenericsMismatch>

Substitute the generic variables as well as the TraitRefKind::SelfId trait ref.
Source§

fn try_substitute( self, generics: &GenericArgs, ) -> Result<Self, GenericsMismatch>

Source§

fn try_substitute_with_self( self, generics: &GenericArgs, self_ref: &TraitRefKind, ) -> Result<Self, GenericsMismatch>

Source§

fn move_under_binder(self) -> Self

Move under one binder.
Source§

fn move_under_binders(self, depth: DeBruijnId) -> Self

Move under depth binders.
Source§

fn move_from_under_binder(self) -> Option<Self>

Move from under one binder.
Source§

fn move_from_under_binders(self, depth: DeBruijnId) -> Option<Self>

Move the value out of depth binders. Returns None if it contains a variable bound in one of these depth binders.
Source§

fn visit_db_id<B>( &mut self, f: impl FnMut(&mut DeBruijnId) -> ControlFlow<B>, ) -> ControlFlow<B>

Visit the de Bruijn ids contained in self, as seen from the outside of self. This means that any variable bound inside self will be skipped, and all the seen indices will count from the outside of self.
Source§

fn has_escaping_region_var(&self) -> bool

Whether this value mentions any region var of its environment.
Source§

fn collect_regions(&self) -> SeqHashSet<Region>

Collect the regions contained in self.
Source§

fn replace_regions(self, f: impl FnMut() -> Region) -> Self

Replace all the regions by the output of the provided function. Binders levels are handled automatically.
Source§

fn replace_erased_regions(self, f: impl FnMut() -> Region) -> Self

Replace all the erased regions by the output of the provided function. Binders levels are handled automatically.
Source§

fn eq_modulo_regions(&self, other: &Self) -> bool

Compare two values, ignoring regions mismatches.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more