Struct codize::List

pub struct List {
    pub separator: String,
    pub trailing: Trailing,
    /* private fields */
}

A list of code segments separated by a separator

Fields

separator: String

The separator between the items

trailing: Trailing

The trailing mode

Implementations

impl List

pub fn empty<TSep: ToString>(sep: TSep) -> Self

Create a new empty code list

pub fn new<TSep, TBody>(sep: TSep, body: TBody) -> Self

where TSep: ToString, TBody: IntoIterator, TBody::Item: Into<Code>,

Create a new code list

pub fn no_trail(self) -> Self

Create a new code list with no trailing separator

pub fn always_trail(self) -> Self

Create a new code list with trailing separator even if the list is in one line

pub fn inline_when(self, condition: fn(_: &List) -> bool) -> Self

Set a condition for displaying the block as one line

pub fn inlined(self) -> Self

Set the inline condition to be always true

pub fn never_inlined(self) -> Self

Set the inline condition to be always false

pub fn body(&self) -> &[Code]

Get the body of the block

pub fn is_empty(&self) -> bool

Get if the list will generate any code or not (empty = no code)

pub fn should_inline(&self) -> bool

Should the list be displayed in one line

pub fn should_inline_intrinsic(&self) -> bool

Should intrinsicly inline the list

This is used for lists that only contain one item

Trait Implementations

impl Debug for List

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

Formats the value using the given formatter.

impl Display for List

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

Formats the value using the given formatter.

impl FormatCode for List

fn size_hint(&self) -> usize

Upperbound for the line count of the code for pre-allocating. Return 0 to skip

fn format_into_vec_with( &self, format: &Format, out: &mut Vec<String>, connect: bool, indent: &str )

Emit self with the format in the given output context

fn format(&self) -> String

Emit self with the default format as a string

fn format_with(&self, format: &Format) -> String

Emit self with the format as a string

fn format_vec_with(&self, format: &Format) -> Vec<String>

Emit self with the format as a vector of lines

impl From<List> for Code

fn from(x: List) -> Self

Converts to this type from the input type.

impl PartialEq for List

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

This method tests for self and other values to be equal, and is used by ==.

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

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