Enum brane_ast::func_id::FunctionId

pub enum FunctionId {
    Main,
    Func(usize),
}

Enum that can be used for function identifiers, to specially handle main.

Variants

Main

It’s the main function

Func(usize)

It’s a non-main function.

Implementations

impl FunctionId

pub const fn main() -> Self

Constructor for the FunctionId that initializes it as a FunctionId::Main.

Returns

A new FunctionId instance.

pub fn func(id: impl AsPrimitive<usize>) -> Self

Constructor for the FunctionId that initializes it as a FunctionId::Func.

Arguments

• id: The identifier of the function to point to.

Returns

A new FunctionId instance.

pub const fn is_main(&self) -> bool

Returns if this FunctionId is a FunctionId::Main.

Returns

True if it is, or false if it’s a FunctionId::Func.

pub const fn is_func(&self) -> bool

Returns if this FunctionId is a FunctionId::Func.

Returns

True if it is, or false if it’s a FunctionId::Main.

pub const fn id(&self) -> usize

Returns the identifier in this FunctionId.

Returns

The identifier within.

Panics

This function panics if it’s not a FunctionId::Func.

Trait Implementations

impl Clone for FunctionId

fn clone(&self) -> FunctionId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionId

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for FunctionId

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

Formats the value using the given formatter.

impl EnumDebug for FunctionId

fn type_name() -> &'static str

Returns the static name of the type used for EnumDebug-printing.

fn variant_names() -> &'static [&'static str]

Returns all variants in the trait as a list of names.

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

Returns the static name of the variant.

fn variant(&self) -> EnumDebugFormatter<'_, Self>

Returns a formatter for this enum that writes its variant name.

fn variants() -> Copied<Iter<'static, &'static str>>

Returns an iterator over all variants in this enum.

impl From<&FunctionId> for FunctionId

fn from(value: &Self) -> Self

Converts to this type from the input type.

impl From<&mut FunctionId> for FunctionId

fn from(value: &mut Self) -> Self

Converts to this type from the input type.

impl From<usize> for FunctionId

fn from(value: usize) -> Self

Converts to this type from the input type.

impl FromStr for FunctionId

type Err = FunctionIdParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for FunctionId

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 PartialEq for FunctionId

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for FunctionId

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for FunctionId

impl Eq for FunctionId

impl StructuralPartialEq for FunctionId