Struct AlignOptions 

pub struct AlignOptions {
    pub align: Alignment,
    pub split: String,
    pub pad: char,
}

Configuration options for text alignment operations.

This struct allows you to customize how text alignment is performed, including the alignment direction, line separator, and padding character.

Examples

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

// Basic usage with default settings
let opts = AlignOptions::new(Alignment::Center);

// Customized options
let opts = AlignOptions::new(Alignment::Right)
    .with_split("|")
    .with_pad('.');

let text = "short|longer text";
let result = ansi_align_with_options(text, &opts);

Fields

align: Alignment

The alignment type (left, center, right)

split: String

The string to split lines on (default: “\n”)

pad: char

The padding character to use (default: “ “)

Implementations

impl AlignOptions

pub fn new(align: Alignment) -> Self

Creates new alignment options with the specified alignment direction.

Uses default values for split string ("\n") and padding character (' ').

Arguments

• align - The alignment direction to use

Examples

use ansi_align::{AlignOptions, Alignment};

let opts = AlignOptions::new(Alignment::Center);

pub fn with_split<S: Into<String>>(self, split: S) -> Self

Sets the string used to split lines using the builder pattern.

By default, lines are split on "\n", but you can specify any string as a line separator.

Arguments

• split - The string to use as a line separator

Examples

use ansi_align::{AlignOptions, Alignment};

let opts = AlignOptions::new(Alignment::Center)
    .with_split("|")
    .with_split("<->"); // Multi-character separators work too

pub const fn with_pad(self, pad: char) -> Self

Sets the character used for padding using the builder pattern.

By default, spaces (' ') are used for padding, but you can specify any character.

Arguments

• pad - The character to use for padding

Examples

use ansi_align::{AlignOptions, Alignment};

let opts = AlignOptions::new(Alignment::Right)
    .with_pad('.');

Trait Implementations

impl Clone for AlignOptions

fn clone(&self) -> AlignOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AlignOptions

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

Formats the value using the given formatter.

impl Default for AlignOptions

fn default() -> Self

Returns the “default value” for a type.