TyDecl

Enum TyDecl 

Source
pub enum TyDecl {
    Model {
        name: Arc<str>,
        params: Vec<Arc<str>>,
        fields: Vec<(Arc<str>, Ty)>,
    },
    Union {
        name: Arc<str>,
        params: Vec<Arc<str>>,
        variants: Vec<Variant>,
    },
    Newtype {
        name: Arc<str>,
        params: Vec<Arc<str>>,
        inner: Ty,
    },
    Alias {
        name: Arc<str>,
        params: Vec<Arc<str>>,
        ty: Ty,
    },
}
Expand description

A user-declared type: a model (record), a union (ADT), a newtype, or an alias.

Comparable because a .becki interface is compared (§3.6, §4.3): two builds agree on a module’s contract exactly when their type declarations are equal.

params is the declaration’s type-parameter names, in order — union Tree[T] has ["T"]. The names are what a .becki renders and what a doc page shows; the field types refer to the parameters positionally through SCHEME_BASE, so a rename is a rename and nothing more. Arity is params.len(), declared rather than inferred from use: a parameter no field mentions is still a parameter, and Phantom[Int] and Phantom[Str] are still different types.

Variants§

§

Model

Fields

§name: Arc<str>
§params: Vec<Arc<str>>
§fields: Vec<(Arc<str>, Ty)>
§

Union

Fields

§name: Arc<str>
§params: Vec<Arc<str>>
§variants: Vec<Variant>
§

Newtype

§3.1’s “zero-cost nominal newtype”: ids of different entities must not be interchangeable.

Fields

§name: Arc<str>
§params: Vec<Arc<str>>
§inner: Ty
§

Alias

Fields

§name: Arc<str>
§params: Vec<Arc<str>>
§ty: Ty

Implementations§

Source§

impl TyDecl

Source

pub fn name(&self) -> &Arc<str>

Source

pub fn params(&self) -> &[Arc<str>]

Source

pub fn arity(&self) -> usize

How many type arguments a mention of this name must carry.

Source

pub fn param_brackets(&self) -> String

[T, U], or the empty string when there is nothing to quantify.

Source

pub fn as_written(&self, t: &Ty) -> Ty

One of this declaration’s field types as the declaration wrote it: the positional parameters put back under the names they were given.

Everything downstream of a TyDecl holds its parameters positionally, which is what makes instantiation an index. Rendering is the one place that has to undo it — a .becki is source, and value: ?1000000 is not something the parser can read back.

Trait Implementations§

Source§

impl Clone for TyDecl

Source§

fn clone(&self) -> TyDecl

Returns a duplicate 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 TyDecl

Source§

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

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

impl PartialEq for TyDecl

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Eq for TyDecl

Source§

impl StructuralPartialEq for TyDecl

Auto Trait Implementations§

§

impl Freeze for TyDecl

§

impl RefUnwindSafe for TyDecl

§

impl Send for TyDecl

§

impl Sync for TyDecl

§

impl Unpin for TyDecl

§

impl UnwindSafe for TyDecl

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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