Skip to main content

ProjectConfig

Struct ProjectConfig 

Source
pub struct ProjectConfig {
Show 13 fields pub extra_abbreviations: Vec<String>, pub ignore_patterns: Vec<String>, pub default_format: Option<String>, pub max_width: Option<usize>, pub long_threshold: Option<usize>, pub clause_breaks: Option<bool>, pub lang: Option<String>, pub org: Option<FormatOverrides>, pub latex: Option<FormatOverrides>, pub markdown: Option<FormatOverrides>, pub rst: Option<FormatOverrides>, pub plaintext: Option<FormatOverrides>, pub code: HashMap<String, CodeLang>,
}
Expand description

Per-project configuration loaded from .snapperrc.toml.

Fields§

§extra_abbreviations: Vec<String>

Additional abbreviations that should not trigger sentence breaks.

§ignore_patterns: Vec<String>

File patterns to ignore (glob syntax).

§default_format: Option<String>

Default format override.

§max_width: Option<usize>

Default max width.

§long_threshold: Option<usize>

Character threshold for advisory long diagnostics when max_width is unset. Defaults to 120 when omitted.

§clause_breaks: Option<bool>

Prefer soft breaks after independent-clause punctuation. With max_width = 0 this still inserts a newline after each mark that is already followed by whitespace.

§lang: Option<String>

Default language for abbreviation sets.

§org: Option<FormatOverrides>

Per-format overrides.

§latex: Option<FormatOverrides>§markdown: Option<FormatOverrides>§rst: Option<FormatOverrides>§plaintext: Option<FormatOverrides>§code: HashMap<String, CodeLang>

Per-language code-block reflow and formatter configuration. Key is the language identifier as it appears on the code fence (e.g. rust, python, toml). Missing languages mean the code block passes through unchanged.

Implementations§

Source§

impl ProjectConfig

Source

pub fn find_and_load(start_dir: &Path) -> Result<Self>

Search for .snapperrc.toml starting from start_dir and walking up to the filesystem root. Returns the default config if none found.

Source

pub fn load(path: &Path) -> Result<Self>

Load config from a specific path.

Source

pub fn resolve(explicit_path: Option<&Path>) -> Result<Self>

Get the config file path if explicitly provided, otherwise search.

Source

pub fn abbreviations_for_format(&self, format: &str) -> Vec<String>

Get merged extra_abbreviations for a specific format, combining top-level abbreviations with per-format overrides.

Source

pub fn max_width_for_format(&self, format: &str) -> Option<usize>

Get max_width for a specific format (per-format overrides top-level).

Source

pub fn latex_verbatim_envs(&self) -> Vec<String>

Extra [latex].verbatim_envs names. Empty when the key is missing.

Source

pub fn latex_structure_envs(&self) -> Vec<String>

Extra [latex].structure_envs names. Empty when the key is missing.

Source

pub fn latex_verbatim_commands(&self) -> Vec<String>

Extra [latex].verbatim_commands names. Empty when the key is missing.

Source

pub fn is_ignored(&self, path: &Path) -> bool

Trait Implementations§

Source§

impl Debug for ProjectConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ProjectConfig

Source§

fn default() -> ProjectConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for ProjectConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more