textum 0.4.0

A syntactic patching library with char-level granularity
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

use std::hash::Hash;

#[cfg(feature = "facet")]
use facet::Facet;

use crate::snip::Target;

/// `BoundaryError` enum type raised by boundary resolution.
pub mod error;
/// Extent configuration for boundary expansion.
pub mod extent;
/// Boundary treatment modes (whether to include/exclude/extend them).
pub mod mode;
/// Boundary resolution struct and `Boundary::resolve` implementation.
pub mod resolution;

pub use error::*;
pub use extent::*;
pub use mode::*;
pub use resolution::*;

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "facet", derive(Facet))]
/// Pairs a target with the mode of inclusion/exclusion/extension of its boundaries.
pub struct Boundary {
    /// The pattern or position defining this boundary.
    pub target: Target,
    /// Whether to include, exclude, or extend beyond this boundary.
    pub mode: BoundaryMode,
}

impl Boundary {
    #[must_use]
    /// Constructs a boundary from a target and mode.
    pub fn new(target: Target, mode: BoundaryMode) -> Self {
        Self { target, mode }
    }
}