charon_lib::ast::gast

Struct TraitDecl

source
pub struct TraitDecl {
    pub def_id: TraitDeclId,
    pub item_meta: ItemMeta,
    pub generics: GenericParams,
    pub parent_clauses: Vector<TraitClauseId, TraitClause>,
    pub consts: Vec<(TraitItemName, Ty)>,
    pub const_defaults: HashMap<TraitItemName, GlobalDeclRef>,
    pub types: Vec<TraitItemName>,
    pub type_defaults: HashMap<TraitItemName, Ty>,
    pub type_clauses: Vec<(TraitItemName, Vector<TraitClauseId, TraitClause>)>,
    pub required_methods: Vec<(TraitItemName, FunDeclId)>,
    pub provided_methods: Vec<(TraitItemName, FunDeclId)>,
}
Expand description

A trait declaration.

For instance:

trait Foo {
  type Bar;

  fn baz(...); // required method (see below)

  fn test() -> bool { true } // provided method (see below)
}

In case of a trait declaration, we don’t include the provided methods (the methods with a default implementation): they will be translated on a per-need basis. This is important for two reasons:

  • this makes the trait definitions a lot smaller (the Iterator trait has one declared function and more than 70 provided functions)
  • this is important for the external traits, whose provided methods often use features we don’t support yet

Remark: In Aeneas, we still translate the provided methods on an individual basis, and in such a way thay they take as input a trait instance. This means that we can use default methods but:

  • implementations of required methods shoudln’t call default methods
  • trait implementations shouldn’t redefine required methods The use case we have in mind is std::iter::Iterator: it declares one required method (next) that should be implemented for every iterator, and defines many helpers like all, map, etc. that shouldn’t be re-implemented. Of course, this forbids other useful use cases such as visitors implemented by means of traits.

Fields§

§def_id: TraitDeclId§item_meta: ItemMeta§generics: GenericParams§parent_clauses: Vector<TraitClauseId, TraitClause>

The “parent” clauses: the supertraits.

Supertraits are actually regular where clauses, but we decided to have a custom treatment.

trait Foo : Bar {
            ^^^
        supertrait, that we treat as a parent predicate
}

TODO: actually, as of today, we consider that all trait clauses of trait declarations are parent clauses.

§consts: Vec<(TraitItemName, Ty)>

The associated constants declared in the trait, along with their type.

§const_defaults: HashMap<TraitItemName, GlobalDeclRef>

Records associated constants that have a default value.

§types: Vec<TraitItemName>

The associated types declared in the trait.

§type_defaults: HashMap<TraitItemName, Ty>

Records associated types that have a default value.

§type_clauses: Vec<(TraitItemName, Vector<TraitClauseId, TraitClause>)>

List of trait clauses that apply to each associated type. This is used during translation, but the lift_associated_item_clauses pass moves them to be parent clauses later. Hence this is empty after that pass. TODO: Do this as we translate to avoid the need to store this vector.

§required_methods: Vec<(TraitItemName, FunDeclId)>

The required methods.

The required methods are the methods declared by the trait but with no default implementation. The corresponding FunDecls don’t have a body.

§provided_methods: Vec<(TraitItemName, FunDeclId)>

The provided methods.

The provided methods are the methods with a default implementation. The corresponding FunDecls may have a body, according to the usual rules for extracting function bodies.

Trait Implementations§

source§

impl Clone for TraitDecl

source§

fn clone(&self) -> TraitDecl

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for TraitDecl

source§

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

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

impl<'de> Deserialize<'de> for TraitDecl

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 Drive for TraitDecl

source§

fn drive<V: Visitor>(&self, visitor: &mut V)

source§

impl DriveMut for TraitDecl

source§

fn drive_mut<V: VisitorMut>(&mut self, visitor: &mut V)

source§

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

source§

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

source§

fn fmt_with_ctx_and_indent(&self, _tab: &str, _ctx: &C) -> String

source§

fn with_ctx<'a>(&'a self, ctx: &'a C) -> impl Display + 'a

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

impl<'a> Formatter<&TraitDecl> for FmtCtx<'a>

source§

impl Serialize for TraitDecl

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

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, dst: *mut T)

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

impl<I, T> ExtractContext<I, ()> for T

§

fn extract_context(self, _original_input: I)

Given the context attached to a nom error, and given the original input to the nom parser, extract more the useful context information. Read more
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
§

impl<I> RecreateContext<I> for I

§

fn recreate_context(_original_input: I, tail: I) -> I

Given the original input, as well as the context reported by nom, recreate a context in the original string where the error occurred. Read more
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
§

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
source§

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