Struct grass::Options

pub struct Options<'a> { /* private fields */ }

Configuration for Sass compilation

The simplest usage is grass::Options::default(); however, a builder pattern is also exposed to offer more control.

Implementations

impl<'a> Options<'a>

pub fn fs(self, fs: &'a dyn Fs) -> Options<'a>

This option allows you to control the file system that Sass will see.

By default, it uses StdFs, which is backed by std::fs, allowing direct, unfettered access to the local file system.

pub fn logger(self, logger: &'a dyn Logger) -> Options<'a>

This option allows you to define how log events should be handled

Be default, StdLogger is used, which writes all events to standard output.

pub const fn style(self, style: OutputStyle) -> Options<'a>

grass currently offers 2 different output styles

• OutputStyle::Expanded writes each selector and declaration on its own line.
• OutputStyle::Compressed removes as many extra characters as possible and writes the entire stylesheet on a single line.

By default, output is expanded.

pub const fn quiet(self, quiet: bool) -> Options<'a>

This flag tells Sass not to emit any warnings when compiling. By default, Sass emits warnings when deprecated features are used or when the @warn rule is encountered. It also silences the @debug rule.

Setting this option to true will stop all logs from reaching the crate::Logger.

By default, this value is false and warnings are emitted.

pub fn load_path<P>(self, path: P) -> Options<'a>

where P: AsRef<Path>,

All Sass implementations allow users to provide load paths: paths on the filesystem that Sass will look in when locating modules. For example, if you pass node_modules/susy/sass as a load path, you can use @import "susy" to load node_modules/susy/sass/susy.scss.

Imports will always be resolved relative to the current file first, though. Load paths will only be used if no relative file exists that matches the module’s URL. This ensures that you can’t accidentally mess up your relative imports when you add a new library.

This method will append a single path to the list.

pub fn load_paths<P>(self, paths: &[P]) -> Options<'a>

where P: AsRef<Path>,

Append multiple loads paths

Note that this method does not remove existing load paths

See Options::load_path for more information about load paths

pub const fn allows_charset(self, allows_charset: bool) -> Options<'a>

This flag tells Sass whether to emit a @charset declaration or a UTF-8 byte-order mark.

By default, Sass will insert either a @charset declaration (in expanded output mode) or a byte-order mark (in compressed output mode) if the stylesheet contains any non-ASCII characters.

pub const fn unicode_error_messages( self, unicode_error_messages: bool ) -> Options<'a>

This flag tells Sass only to emit ASCII characters as part of error messages.

By default Sass will emit non-ASCII characters for these messages.

This flag does not affect the CSS output.

pub const fn input_syntax(self, syntax: InputSyntax) -> Options<'a>

This option forces Sass to parse input using the given syntax.

By default, Sass will attempt to read the file extension to determine the syntax. If this is not possible, it will default to InputSyntax::Scss.

This flag only affects the first file loaded. Files that are loaded using @import, @use, or @forward will always have their syntax inferred.

pub fn add_custom_fn<S>(self, name: S, func: Builtin) -> Options<'a>

where S: Into<String>,

Add a custom function accessible from within Sass

See the Builtin documentation for additional information

Trait Implementations

impl<'a> Debug for Options<'a>

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

Formats the value using the given formatter.

impl Default for Options<'_>

fn default() -> Options<'_>

Returns the “default value” for a type.