Struct text_layout::FirstFit
source · pub struct FirstFit<N> { /* private fields */ }
Expand description
Runs the first-fit line-breaking algorithm to calculate the break points for a paragraph.
Implementations§
source§impl<N: Num> FirstFit<N>
impl<N: Num> FirstFit<N>
sourcepub fn new() -> Self
pub fn new() -> Self
Creates a new FirstFit layout with default parameter values.
Examples found in repository?
examples/first_fit.rs (line 60)
58 59 60 61 62 63 64 65 66 67 68 69 70
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)
}
More examples
examples/first_fit_overflow.rs (line 60)
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
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)
}
sourcepub fn with_threshold(self, threshold: N) -> Self
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)
58 59 60 61 62 63 64 65 66 67 68 69 70
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)
}
More examples
examples/first_fit_overflow.rs (line 61)
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
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)
}
sourcepub fn allow_overflow(self, allow_overflow: bool) -> Self
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)
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
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§
source§impl<Box, Glue, Penalty, N: Num> ParagraphLayout<Box, Glue, Penalty, N> for FirstFit<N>
impl<Box, Glue, Penalty, N: Num> ParagraphLayout<Box, Glue, Penalty, N> for FirstFit<N>
Auto Trait Implementations§
impl<N> RefUnwindSafe for FirstFit<N>where
N: RefUnwindSafe,
impl<N> Send for FirstFit<N>where
N: Send,
impl<N> Sync for FirstFit<N>where
N: Sync,
impl<N> Unpin for FirstFit<N>where
N: Unpin,
impl<N> UnwindSafe for FirstFit<N>where
N: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CheckedAs for T
impl<T> CheckedAs for T
source§fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
fn checked_as<Dst>(self) -> Option<Dst>where
T: CheckedCast<Dst>,
Casts the value.
source§impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
impl<Src, Dst> CheckedCastFrom<Src> for Dstwhere
Src: CheckedCast<Dst>,
source§fn checked_cast_from(src: Src) -> Option<Dst>
fn checked_cast_from(src: Src) -> Option<Dst>
Casts the value.
source§impl<Src, Dst> LosslessTryInto<Dst> for Srcwhere
Dst: LosslessTryFrom<Src>,
impl<Src, Dst> LosslessTryInto<Dst> for Srcwhere
Dst: LosslessTryFrom<Src>,
source§fn lossless_try_into(self) -> Option<Dst>
fn lossless_try_into(self) -> Option<Dst>
Performs the conversion.
source§impl<Src, Dst> LossyInto<Dst> for Srcwhere
Dst: LossyFrom<Src>,
impl<Src, Dst> LossyInto<Dst> for Srcwhere
Dst: LossyFrom<Src>,
source§fn lossy_into(self) -> Dst
fn lossy_into(self) -> Dst
Performs the conversion.
source§impl<T> OverflowingAs for T
impl<T> OverflowingAs for T
source§fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
fn overflowing_as<Dst>(self) -> (Dst, bool)where
T: OverflowingCast<Dst>,
Casts the value.
source§impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
impl<Src, Dst> OverflowingCastFrom<Src> for Dstwhere
Src: OverflowingCast<Dst>,
source§fn overflowing_cast_from(src: Src) -> (Dst, bool)
fn overflowing_cast_from(src: Src) -> (Dst, bool)
Casts the value.
source§impl<T> SaturatingAs for T
impl<T> SaturatingAs for T
source§fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
fn saturating_as<Dst>(self) -> Dstwhere
T: SaturatingCast<Dst>,
Casts the value.
source§impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
impl<Src, Dst> SaturatingCastFrom<Src> for Dstwhere
Src: SaturatingCast<Dst>,
source§fn saturating_cast_from(src: Src) -> Dst
fn saturating_cast_from(src: Src) -> Dst
Casts the value.
source§impl<T> UnwrappedAs for T
impl<T> UnwrappedAs for T
source§fn unwrapped_as<Dst>(self) -> Dstwhere
T: UnwrappedCast<Dst>,
fn unwrapped_as<Dst>(self) -> Dstwhere
T: UnwrappedCast<Dst>,
Casts the value.
source§impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere
Src: UnwrappedCast<Dst>,
impl<Src, Dst> UnwrappedCastFrom<Src> for Dstwhere
Src: UnwrappedCast<Dst>,
source§fn unwrapped_cast_from(src: Src) -> Dst
fn unwrapped_cast_from(src: Src) -> Dst
Casts the value.
source§impl<T> WrappingAs for T
impl<T> WrappingAs for T
source§fn wrapping_as<Dst>(self) -> Dstwhere
T: WrappingCast<Dst>,
fn wrapping_as<Dst>(self) -> Dstwhere
T: WrappingCast<Dst>,
Casts the value.
source§impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere
Src: WrappingCast<Dst>,
impl<Src, Dst> WrappingCastFrom<Src> for Dstwhere
Src: WrappingCast<Dst>,
source§fn wrapping_cast_from(src: Src) -> Dst
fn wrapping_cast_from(src: Src) -> Dst
Casts the value.