Skip to main content

Directive

Struct Directive 

Source
pub struct Directive {
    pub span: Span,
    pub leading_comments: Vec<String>,
    pub trailing_comment: Option<String>,
    pub kind: DirectiveKind,
}
Expand description

A single chrony directive with its source location and comments.

Each directive carries its original source location (Span), any leading comments (comment lines immediately preceding the directive), an optional trailing comment (inline comment after the directive), and the parsed directive body (DirectiveKind).

Comments are preserved for lossless round-trip serialization.

§Examples

use chrony_confile::ChronyConfig;

let config: ChronyConfig = "# My NTP server\nserver ntp.example.com iburst  # preferred\n".parse()?;

let directive = config.directives().next().unwrap();
assert_eq!(directive.leading_comments[0], "My NTP server");
assert_eq!(directive.trailing_comment.as_deref(), Some("preferred"));

Fields§

§span: Span

Source location of the directive.

§leading_comments: Vec<String>

Comments on lines immediately preceding the directive.

§trailing_comment: Option<String>

An inline comment after the directive, if present.

§kind: DirectiveKind

The parsed directive body.

Implementations§

Source§

impl Directive

Source

pub fn new(kind: DirectiveKind, span: Span) -> Self

Creates a new directive with the given kind and source span.

Source

pub fn with_leading_comment(self, comment: impl Into<String>) -> Self

Builder-style method to add a leading comment.

Source

pub fn with_trailing_comment(self, comment: impl Into<String>) -> Self

Builder-style method to add a trailing comment.

Trait Implementations§

Source§

impl Clone for Directive

Source§

fn clone(&self) -> Directive

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Directive

Source§

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

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

impl From<Directive> for ConfigNode

Source§

fn from(d: Directive) -> Self

Converts to this type from the input type.
Source§

impl From<DirectiveKind> for Directive

Source§

fn from(kind: DirectiveKind) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Directive

Source§

fn eq(&self, other: &Directive) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for Directive

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.