Struct lightningcss::printer::Printer

pub struct Printer<'a, 'b, 'c, W> { /* private fields */ }

A Printer represents a destination to output serialized CSS, as used in the ToCss trait. It can wrap any destination that implements std::fmt::Write, such as a String.

A Printer keeps track of the current line and column position, and uses this to generate a source map if provided in the options.

Printer also includes helper functions that assist with writing output that respects options such as minify, and css_modules.

Implementations

impl<'a, 'b, 'c, W: Write + Sized> Printer<'a, 'b, 'c, W>

pub fn new(dest: &'a mut W, options: PrinterOptions<'a>) -> Self

Create a new Printer wrapping the given destination.

pub fn filename(&self) -> &'c str

Returns the current source filename that is being printed.

pub fn write_str(&mut self, s: &str) -> Result<(), PrinterError>

Writes a raw string to the underlying destination.

NOTE: Is is assumed that the string does not contain any newline characters. If such a string is written, it will break source maps.

pub fn write_char(&mut self, c: char) -> Result<(), PrinterError>

Write a single character to the underlying destination.

pub fn whitespace(&mut self) -> Result<(), PrinterError>

Writes a single whitespace character, unless the minify option is enabled.

Use write_char instead if you wish to force a space character to be written, regardless of the minify option.

pub fn delim(&mut self, delim: char, ws_before: bool) -> Result<(), PrinterError>

Writes a delimeter character, followed by whitespace (depending on the minify option). If ws_before is true, then whitespace is also written before the delimeter.

pub fn newline(&mut self) -> Result<(), PrinterError>

Writes a newline character followed by indentation. If the minify option is enabled, then nothing is printed.

pub fn indent(&mut self)

Increases the current indent level.

pub fn dedent(&mut self)

Decreases the current indent level.

pub fn indent_by(&mut self, amt: u8)

Increases the current indent level by the given number of characters.

pub fn dedent_by(&mut self, amt: u8)

Decreases the current indent level by the given number of characters.

pub fn is_nested(&self) -> bool

Returns whether the indent level is greater than one.

pub fn add_mapping(&mut self, loc: Location)

Adds a mapping to the source map, if any.

pub fn write_ident(&mut self, ident: &str) -> Result<(), PrinterError>

Writes a CSS identifier to the underlying destination, escaping it as appropriate. If the css_modules option was enabled, then a hash is added, and the mapping is added to the CSS module.

pub fn error(
    &self,
    kind: PrinterErrorKind,
    loc: Location
) -> Error<PrinterErrorKind>

Returns an error of the given kind at the provided location in the current source file.

Trait Implementations

impl<'a, 'b, 'c, W: Write + Sized> Write for Printer<'a, 'b, 'c, W>

fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.