Struct ChangelogFile

pub struct ChangelogFile { /* private fields */ }

A changelog file

Implementations

impl ChangelogFile

pub fn from_path(path: &Path) -> Result<ChangelogFile>

Load ChangelogFile from a given path

pub fn from_string(version: &str, sql: &str) -> Result<ChangelogFile>

Create ChangelogFile from a version and a string containing the contents

pub fn iter(&self) -> SqlStatementIterator

Create an iterator for the statements of this ChangelogFile

pub fn version(&self) -> &str

Get the version of this ChangelogFile

pub fn content(&self) -> &str

Get the raw text of the ChangelogFile

Trait Implementations

impl Clone for ChangelogFile

fn clone(&self) -> ChangelogFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChangelogFile

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

Formats the value using the given formatter.

impl Ord for ChangelogFile

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ChangelogFile

fn eq(&self, other: &Self) -> 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 PartialOrd for ChangelogFile

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ChangelogFile