burn_core::module

Struct DisplaySettings

Source 
pub struct DisplaySettings { /* private fields */ }
Expand description

Custom module display settings.

Implementations§

Source§

impl DisplaySettings

Source

pub fn new() -> Self

Create a new format settings.

§Returns

A new instance of DisplaySettings.

Source

pub fn with_show_param_id(self, flag: bool) -> Self

Sets a flag to show module parameters.

§Arguments
  • flag - Boolean flag to show module parameters.
§Returns

Updated DisplaySettings instance.

Source

pub fn with_show_all_attributes(self, flag: bool) -> Self

Sets a flag to show module attributes.

§Arguments
  • flag - Boolean flag to show all module attributes.
§Returns

Updated DisplaySettings instance.

Source

pub fn with_show_num_parameters(self, flag: bool) -> Self

Sets a flag to show the number of module parameters.

§Arguments
  • flag - Boolean flag to show the number of module parameters.
§Returns

Updated DisplaySettings instance.

Source

pub fn with_new_line_after_attribute(self, flag: bool) -> Self

Sets a flag to print a new line after an attribute.

§Arguments
  • flag - Boolean flag to print a new line after an attribute.
§Returns

Updated DisplaySettings instance.

Source

pub fn with_indentation_size(self, size: usize) -> Self

Sets the indentation size.

§Arguments
  • size - The size of the indentation.
§Returns

Updated DisplaySettings instance.

Source

pub fn inherit(self, top: Self) -> Self

Inherits settings from the provided settings and return a new settings object.

§Arguments
  • top - The top level DisplaySettings to inherit from.
§Returns

Updated DisplaySettings instance.

Source

pub fn optional(self) -> Option<Self>

A convenience method to wrap the DisplaySettings struct in an option.

§Returns

An optional DisplaySettings.

Source

pub fn level_up(self) -> Self

Increases the level of indentation.

§Returns

Updated DisplaySettings instance with increased indentation level.

Source

pub fn show_param_id(&self) -> bool

Gets show_param_id flag, substitutes false if not set.

This flag is used to print the module parameter ids.

§Returns

A boolean value indicating whether to show parameter ids.

Source

pub fn show_all_attributes(&self) -> bool

Gets show_all_attributes, substitutes false if not set.

This flag is used to force to print all module attributes, overriding custom attributes.

§Returns

A boolean value indicating whether to show all attributes.

Source

pub fn show_num_parameters(&self) -> bool

Gets show_num_parameters, substitutes true if not set.

This flag is used to print the number of module parameters.

§Returns

A boolean value indicating whether to show the number of parameters.

Source

pub fn new_line_after_attribute(&self) -> bool

Gets new_line_after_attribute, substitutes true if not set.

This flag is used to print a new line after an attribute.

§Returns

A boolean value indicating whether to print a new line after an attribute.

Source

pub fn indentation_size(&self) -> usize

Gets indentation_size, substitutes 2 if not set.

This flag is used to set the size of indentation.

§Returns

An integer value indicating the size of indentation.

Trait Implementations§

Source§

impl Clone for DisplaySettings

Source§

fn clone(&self) -> DisplaySettings

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 DisplaySettings

Source§

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

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

impl Default for DisplaySettings

Source§

fn default() -> Self

Returns the “default value” for a type. 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, 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> Instrument for T

Source§

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

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

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T