Struct text_layout::FirstFit

pub struct FirstFit<N> { /* private fields */ }

Runs the first-fit line-breaking algorithm to calculate the break points for a paragraph.

Implementations

impl<N: Num> FirstFit<N>

pub fn new() -> Self

Creates a new FirstFit layout with default parameter values.

Examples found in repository

examples/first_fit.rs (line 60)

fn layout_text() -> Result<String, fmt::Error> {
    let text = "  Far out in the uncharted backwaters of the unfashionable end of the western spiral arm of the Galaxy lies a small unregarded yellow sun. Orbiting this at a distance of roughly ninety-two million miles is an utterly insignificant little blue-green planet whose ape-descended life forms are so amazingly primitive that they still think digital watches are a pretty neat idea.";
    let first_fit = FirstFit::new().with_threshold(f32::INFINITY);
    let lines = layout_paragraph(&text, &first_fit, 80);
    let mut result = String::new();
    writeln!(&mut result, "┏{}┓", "━".repeat(80))?;
    for l in lines {
        let pad = 80 - l.chars().count();
        writeln!(&mut result, "┃{}{}┃", l, " ".repeat(pad))?;
    }
    writeln!(&mut result, "┗{}┛", "━".repeat(80))?;
    Ok(result)
}

examples/first_fit_overflow.rs (line 60)

fn layout_text() -> Result<String, fmt::Error> {
    let text = "FaroutintheunchartedbackwatersoftheunfashionableendofthewesternspiralarmoftheGalaxy lies a small unregarded yellow sun. Orbiting this at a distance of roughly ninety-two million miles is an utterly insignificant little blue-green planet whose ape-descended life forms are so amazingly primitive that they still think digital watches are a pretty neat idea.";
    let first_fit = FirstFit::new()
        .with_threshold(f32::INFINITY)
        .allow_overflow(true);
    let lines = layout_paragraph(&text, &first_fit, 80);
    let mut result = String::new();
    writeln!(&mut result, "┏{}┓", "━".repeat(80))?;
    for l in lines {
        let pad = 80_usize.saturating_sub(l.chars().count());
        writeln!(&mut result, "┃{}{}┃", l, " ".repeat(pad))?;
    }
    writeln!(&mut result, "┗{}┛", "━".repeat(80))?;
    Ok(result)
}

pub fn with_threshold(self, threshold: N) -> Self

Sets the adjustment ratio threshold. Lines will not be allowed to break at a given point if doing so would cause the line’s adjustment ratio to exceed this value. Defaults to 1.

Examples found in repository

examples/first_fit.rs (line 60)

fn layout_text() -> Result<String, fmt::Error> {
    let text = "  Far out in the uncharted backwaters of the unfashionable end of the western spiral arm of the Galaxy lies a small unregarded yellow sun. Orbiting this at a distance of roughly ninety-two million miles is an utterly insignificant little blue-green planet whose ape-descended life forms are so amazingly primitive that they still think digital watches are a pretty neat idea.";
    let first_fit = FirstFit::new().with_threshold(f32::INFINITY);
    let lines = layout_paragraph(&text, &first_fit, 80);
    let mut result = String::new();
    writeln!(&mut result, "┏{}┓", "━".repeat(80))?;
    for l in lines {
        let pad = 80 - l.chars().count();
        writeln!(&mut result, "┃{}{}┃", l, " ".repeat(pad))?;
    }
    writeln!(&mut result, "┗{}┛", "━".repeat(80))?;
    Ok(result)
}

examples/first_fit_overflow.rs (line 61)

fn layout_text() -> Result<String, fmt::Error> {
    let text = "FaroutintheunchartedbackwatersoftheunfashionableendofthewesternspiralarmoftheGalaxy lies a small unregarded yellow sun. Orbiting this at a distance of roughly ninety-two million miles is an utterly insignificant little blue-green planet whose ape-descended life forms are so amazingly primitive that they still think digital watches are a pretty neat idea.";
    let first_fit = FirstFit::new()
        .with_threshold(f32::INFINITY)
        .allow_overflow(true);
    let lines = layout_paragraph(&text, &first_fit, 80);
    let mut result = String::new();
    writeln!(&mut result, "┏{}┓", "━".repeat(80))?;
    for l in lines {
        let pad = 80_usize.saturating_sub(l.chars().count());
        writeln!(&mut result, "┃{}{}┃", l, " ".repeat(pad))?;
    }
    writeln!(&mut result, "┗{}┛", "━".repeat(80))?;
    Ok(result)
}

pub fn allow_overflow(self, allow_overflow: bool) -> Self

Configures the layout to allow lines that exceed the maximum line with if the layout would fail otherwise.

Examples found in repository

examples/first_fit_overflow.rs (line 62)

fn layout_text() -> Result<String, fmt::Error> {
    let text = "FaroutintheunchartedbackwatersoftheunfashionableendofthewesternspiralarmoftheGalaxy lies a small unregarded yellow sun. Orbiting this at a distance of roughly ninety-two million miles is an utterly insignificant little blue-green planet whose ape-descended life forms are so amazingly primitive that they still think digital watches are a pretty neat idea.";
    let first_fit = FirstFit::new()
        .with_threshold(f32::INFINITY)
        .allow_overflow(true);
    let lines = layout_paragraph(&text, &first_fit, 80);
    let mut result = String::new();
    writeln!(&mut result, "┏{}┓", "━".repeat(80))?;
    for l in lines {
        let pad = 80_usize.saturating_sub(l.chars().count());
        writeln!(&mut result, "┃{}{}┃", l, " ".repeat(pad))?;
    }
    writeln!(&mut result, "┗{}┛", "━".repeat(80))?;
    Ok(result)
}

Trait Implementations

impl<N: Num> Default for FirstFit<N>

fn default() -> Self

Returns the “default value” for a type.

impl<Box, Glue, Penalty, N: Num> ParagraphLayout<Box, Glue, Penalty, N> for FirstFit<N>

fn layout_paragraph( &self, items: &[Item<Box, Glue, Penalty, N>], line_width: N ) -> Vec<Line<N>>

Lays out a paragraph with the given line width that consists of as list of items and returns the laid-out lines.