Module

Struct Module 

Source
pub struct Module<'a> { /* private fields */ }
Expand description

Top-level module definition in a jeff program.

Implementations§

Source§

impl<'a> Module<'a>

Source

pub fn version(&self) -> u32

Version of the jeff protocol used in this module.

Source

pub fn functions(&self) -> impl Iterator<Item = Function<'a>>

Returns an iterator over the functions defined in this module.

Source

pub fn function_count(&self) -> usize

Returns the number of functions defined in this module.

Source

pub fn function(&self, n: FunctionId) -> Function<'a>

Returns the n-th function defined in this module.

§Panics

Panics if n is equal or greater than Module::function_count.

Source

pub fn try_function(&self, n: FunctionId) -> Option<Function<'a>>

Returns the n-th function defined in this module.

Source

pub fn strings(&self) -> StringTable<'a>

Returns the internal storage of strings.

Source

pub fn entrypoint_id(&self) -> FunctionId

Returns the FunctionId of the entrypoint function for this module.

Source

pub fn entrypoint(&self) -> Function<'a>

Returns the entrypoint function for this module.

§Panics

Panics if the entrypoint id in the jeff definition is out of range.

Source

pub fn tool(&self) -> &str

Returns the tool name used to generate this program.

See Module::tool_version.

Source

pub fn tool_version(&self) -> &str

Returns the tool version used to generate this program.

See Module::tool.

Trait Implementations§

Source§

impl<'a> Clone for Module<'a>

Source§

fn clone(&self) -> Module<'a>

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<'a> Debug for Module<'a>

Source§

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

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

impl<'a> Copy for Module<'a>

Auto Trait Implementations§

§

impl<'a> Freeze for Module<'a>

§

impl<'a> !RefUnwindSafe for Module<'a>

§

impl<'a> !Send for Module<'a>

§

impl<'a> !Sync for Module<'a>

§

impl<'a> Unpin for Module<'a>

§

impl<'a> !UnwindSafe for Module<'a>

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