Struct PaddedValue 

pub struct PaddedValue<Value, PadBlock = char, HandleExcess = ExcessHandlingFunction<Value, PadBlock>, Pad = Alignment>
where
    Value: Width,
    PadBlock: Display,
    HandleExcess: ExcessHandler<Value, PadBlock>,
    Pad: Pad<Value, PadBlock>,
{
    pub value: Value,
    pub pad_block: PadBlock,
    pub total_width: usize,
    pub pad: Pad,
    pub handle_excess: HandleExcess,
}

Pad a single value.

Key traits:

• Display: Displays the padded version of the value.

Example: Pad dash characters to the left of a string

use zero_copy_pads::{PaddedValue, AlignRight, PanicOnExcess};
let padded_value = PaddedValue {
    value: "abcdef",
    pad_block: '-',
    total_width: 9,
    pad: AlignRight,
    handle_excess: PanicOnExcess,
};
assert_eq!(padded_value.to_string(), "---abcdef");

Example: Use a builder (requires std feature)

use zero_copy_pads::{PaddedValueBuilder, AlignRight, PanicOnExcess};
let padded_value = PaddedValueBuilder::default()
    .value("abcdef")
    .pad_block('-')
    .total_width(9)
    .pad(AlignRight)
    .handle_excess(PanicOnExcess)
    .build()
    .unwrap();
assert_eq!(padded_value.to_string(), "---abcdef");

Fields

value: Value

Value to be padded.

pad_block: PadBlock

Block of the pad (expected to have width of 1).

total_width: usize

Total width to fulfill.

pad: Pad

How to pad.

handle_excess: HandleExcess

How to write when the actual width of value exceeds total_width.

Trait Implementations

impl<Value, PadBlock, HandleExcess, Pad> Clone for PaddedValue<Value, PadBlock, HandleExcess, Pad>

where Value: Width + Clone, PadBlock: Display + Clone, HandleExcess: ExcessHandler<Value, PadBlock> + Clone, Pad: Pad<Value, PadBlock> + Clone,

fn clone(&self) -> PaddedValue<Value, PadBlock, HandleExcess, Pad>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Value, PadBlock, HandleExcess, Pad> Debug for PaddedValue<Value, PadBlock, HandleExcess, Pad>

where Value: Width + Debug, PadBlock: Display + Debug, HandleExcess: ExcessHandler<Value, PadBlock> + Debug, Pad: Pad<Value, PadBlock> + Debug,

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

Formats the value using the given formatter.

impl<Value, PadBlock, HandleExcess, Pad> Display for PaddedValue<Value, PadBlock, HandleExcess, Pad>

where Value: Width, PadBlock: Display, HandleExcess: ExcessHandler<Value, PadBlock>, Pad: Pad<Value, PadBlock>,

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

Formats the value using the given formatter.

impl<Value, PadBlock, HandleExcess, Pad> Width for PaddedValue<Value, PadBlock, HandleExcess, Pad>

where Value: Width, PadBlock: Display, HandleExcess: ExcessHandler<Value, PadBlock>, Pad: Pad<Value, PadBlock>,

fn width(&self) -> usize

Get width of the value.

impl<Value, PadBlock, HandleExcess, Pad> Copy for PaddedValue<Value, PadBlock, HandleExcess, Pad>

where Value: Width + Copy, PadBlock: Display + Copy, HandleExcess: ExcessHandler<Value, PadBlock> + Copy, Pad: Pad<Value, PadBlock> + Copy,