pub struct File {
pub header: Header,
pub design_units: FixWord,
pub char_dimens: BTreeMap<Char, CharDimensions>,
pub char_tags: BTreeMap<Char, CharTag>,
pub unset_char_tags: BTreeMap<Char, u8>,
pub lig_kern_program: Program,
pub params: Vec<FixWord>,
pub additional_widths: Vec<FixWord>,
pub additional_heights: Vec<FixWord>,
pub additional_depths: Vec<FixWord>,
pub additional_italics: Vec<FixWord>,
}Expand description
Complete contents of a property list (.pl) file.
Fields§
§header: Header§design_units: FixWord§char_dimens: BTreeMap<Char, CharDimensions>Tags that have been unset, but whose discriminant is still written to a .tfm file by PLtoTF.
lig_kern_program: Program§params: Vec<FixWord>§additional_widths: Vec<FixWord>Additional widths that appear in the plst file but not appear in the fully parsed file.
This can happen due to the following plst listing:
(CHARACTER C X (CHARWD D 8.0))
(CHARACTER C X (CHARWD D 9.0))
In this case the width 8.0 is not in the fully parsed file because it is overwritten
by 9.0.
However pltotf still writes the 8.0 width to the .tfm file.
additional_heights: Vec<FixWord>Additional heights; similar to additional widths.
additional_depths: Vec<FixWord>Additional depths; similar to additional widths.
additional_italics: Vec<FixWord>Additional italic corrections; similar to additional widths.
Implementations§
source§impl File
impl File
sourcepub fn from_pl_source_code(source: &str) -> (File, Vec<ParseWarning>)
pub fn from_pl_source_code(source: &str) -> (File, Vec<ParseWarning>)
Build a File from PL source code.
sourcepub fn lig_kern_entrypoints(&self, include_orphans: bool) -> HashMap<Char, u16>
pub fn lig_kern_entrypoints(&self, include_orphans: bool) -> HashMap<Char, u16>
Return a map from characters to the lig/kern entrypoint for that character.
sourcepub fn clear_lig_kern_data(&mut self)
pub fn clear_lig_kern_data(&mut self)
Clear all lig/kern data from the file.
source§impl File
impl File
sourcepub fn lower(&self, char_display_format: CharDisplayFormat) -> Ast
pub fn lower(&self, char_display_format: CharDisplayFormat) -> Ast
Lower a File to an AST.
sourcepub fn display(
&self,
indent: usize,
char_display_format: CharDisplayFormat,
) -> Display<'_>
pub fn display( &self, indent: usize, char_display_format: CharDisplayFormat, ) -> Display<'_>
Display this file.
This function returns a helper type that implements the std::fmt::Display
trait and can be used in print! and similar macros.
Trait Implementations§
impl Eq for File
impl StructuralPartialEq for File
Auto Trait Implementations§
impl Freeze for File
impl RefUnwindSafe for File
impl Send for File
impl Sync for File
impl Unpin for File
impl UnwindSafe for File
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
§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling [Attribute] value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi [Quirk] value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the [Condition] value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);