Struct ListOptions 

pub struct ListOptions { /* private fields */ }

Builder-style configuration for list formatting.

humfmt list formatting is intentionally minimal and predictable: it joins slices into natural-language lists with optional overrides.

Examples

use humfmt::ListOptions;

let opts = ListOptions::new()
    .serial_comma_enabled(false)
    .conjunction("plus");

assert_eq!(
    humfmt::list_with(&["red", "green", "blue"], opts).to_string(),
    "red, green plus blue"
);

Implementations

impl ListOptions

pub const fn new() -> Self

Creates default list formatting options.

Defaults:

• serial comma: enabled (Oxford comma)
• conjunction: "and"
• separator: ", "

pub const fn serial_comma(self) -> Self

Enables the serial comma before the final list item.

Equivalent to .serial_comma_enabled(true).

pub const fn serial_comma_enabled(self, enabled: bool) -> Self

Configures serial-comma behavior with an explicit boolean.

• true: "a, b, and c"
• false: "a, b and c"

pub const fn no_serial_comma(self) -> Self

Disables the serial comma before the final list item.

Equivalent to .serial_comma_enabled(false).

pub const fn conjunction(self, word: &'static str) -> Self

Overrides the conjunction used to join the final list item.

Default is "and".

Example: "plus" produces "a, b plus c".

pub const fn separator(self, sep: &'static str) -> Self

Overrides the separator placed between list items.

Default is ", ".

Note: serial comma is only injected when the separator is comma-style. Custom separators like " | " will not get a serial comma even if enabled.

Trait Implementations

impl Clone for ListOptions

fn clone(&self) -> ListOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListOptions

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

Formats the value using the given formatter.

impl Default for ListOptions

fn default() -> Self

Returns the “default value” for a type.

impl Copy for ListOptions