Enum Alignment 

pub enum Alignment {
    Left,
    Center,
    Right,
}

Specifies the alignment direction for text.

This enum defines the three fundamental alignment options available in the library. Each variant represents a different strategy for positioning text within the available width.

Alignment Behavior

• Left: Text is positioned at the leftmost edge (no padding on left)
• Center: Text is centered with equal padding on both sides
• Right: Text is positioned at the rightmost edge (padding on left)

Performance Notes

• Left alignment is optimized as a no-op operation
• Center and Right alignments require width calculation and padding

Examples

Basic Usage

use ansi_align::{Alignment, AlignOptions, ansi_align_with_options};

let text = "hello\nworld";

// Center alignment - distributes padding evenly
let opts = AlignOptions::new(Alignment::Center);
let result = ansi_align_with_options(text, &opts);
// Result: " hello\nworld" (hello gets 1 space padding)

// Right alignment - adds all padding to the left
let opts = AlignOptions::new(Alignment::Right);
let result = ansi_align_with_options(text, &opts);
// Result: " hello\n world" (both lines right-aligned)

// Left alignment - no changes to input
let opts = AlignOptions::new(Alignment::Left);
let result = ansi_align_with_options(text, &opts);
// Result: "hello\nworld" (unchanged)

With Custom Padding

use ansi_align::{Alignment, AlignOptions, ansi_align_with_options};

let text = "short\nlonger";
let opts = AlignOptions::new(Alignment::Right).with_pad('.');
let result = ansi_align_with_options(text, &opts);
// Result: ".short\nlonger"

Variants

Left

Align text to the left (no padding added to the left side)

Center

Align text to the center (padding distributed evenly on both sides)

Right

Align text to the right (padding added to the left side)

Trait Implementations

impl Clone for Alignment

fn clone(&self) -> Alignment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Alignment

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

Formats the value using the given formatter.

impl PartialEq for Alignment

fn eq(&self, other: &Alignment) -> 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 Copy for Alignment

impl Eq for Alignment

impl StructuralPartialEq for Alignment