Struct RevisionLine 

pub struct RevisionLine<'src> { /* private fields */ }

The revision line is the line directly after the author line in the document header. When the content on this line is structured correctly, the processor assigns the content to the built-in revnumber, revdate, and revremark attributes.

Implementations

impl<'src> RevisionLine<'src>

pub fn revnumber(&self) -> Option<&str>

Returns the revision number, if present.

The document’s revision number or version is assigned to the built-in revnumber attribute. When assigned using the revision line, the version must contain at least one number, and, if it isn’t followed by a date or remark, it must begin with the letter v (e.g., v7.0.6). Any letters or symbols preceding the number, including v, are dropped when the document is rendered. If revnumber is set with an attribute entry, it doesn’t have to contain a number and the entire value is displayed in the rendered document.

pub fn revdate(&self) -> &str

Returns the revision date.

The date the revision was completed is assigned to the built-in revdate attribute. If the date is assigned using the revision line, it must be separated from the version by a comma (e.g., 78.1, 2020-10-10). The date can contain letters, numbers, symbols, and attribute references.

pub fn revremark(&self) -> Option<&str>

Returns the revision remark, if present.

Remarks about the revision of the document are assigned to the built-in revremark attribute. The remark must be separated by a colon (:) from the version or revision date when assigned using the revision line.

Trait Implementations

impl<'src> Clone for RevisionLine<'src>

fn clone(&self) -> RevisionLine<'src>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'src> Debug for RevisionLine<'src>

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

Formats the value using the given formatter.

impl<'src> HasSpan<'src> for RevisionLine<'src>

fn span(&self) -> Span<'src>

Return a Span describing the syntactic element’s location within the source string/file.

impl<'src> PartialEq for RevisionLine<'src>

fn eq(&self, other: &RevisionLine<'src>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<'src> Eq for RevisionLine<'src>

impl<'src> StructuralPartialEq for RevisionLine<'src>