Skip to main content

ChangelogAction

Enum ChangelogAction 

Source
pub enum ChangelogAction {
    ReplaceEntryChanges {
        file: PathBuf,
        version: String,
        lines: Vec<String>,
    },
    SetEntryDate {
        file: PathBuf,
        version: String,
        rfc2822: String,
    },
    RemoveBullet {
        file: PathBuf,
        version: String,
        author: Option<String>,
        text: String,
        occurrence: usize,
    },
    ReplaceBullet {
        file: PathBuf,
        version: String,
        author: Option<String>,
        text: String,
        occurrence: usize,
        new_lines: Vec<String>,
    },
    SetEntryVersion {
        file: PathBuf,
        version: String,
        new_version: String,
    },
}
Expand description

Edits to a debian/changelog.

Operations target entries by their version, which is stable across minor edits. Change-line content is supplied verbatim — the applier preserves the changelog’s existing indentation rules when re-rendering.

Variants§

§

ReplaceEntryChanges

Replace the change lines of the entry with the given version. The lines are stored verbatim with their leading */ continuation prefix; the applier writes them as-is into the entry.

Fields

§file: PathBuf

File to edit, relative to the package root. Almost always debian/changelog, but kept explicit for symmetry.

§version: String

Version string of the target entry (e.g. 2.6.0-1).

§lines: Vec<String>

Replacement change lines (one per line, no trailing newline).

§

SetEntryDate

Set the trailer datetime of the entry with the given version.

The datetime is stored as an RFC 2822 string ("Sun, 22 Apr 2018 00:58:14 +0000") — what chrono::DateTime::to_rfc2822 produces and what changelog trailers use natively.

Fields

§file: PathBuf

File to edit, relative to the package root.

§version: String

Version string of the target entry.

§rfc2822: String

New datetime as an RFC 2822 string.

§

RemoveBullet

Remove a bullet from the entry with the given version.

The bullet is identified by its author attribution (the [ Name ] header that introduces multi-author groups, or None for an entry without one) and its body text (the bullet’s lines joined with \n, exactly as debian_changelog’s Bullet::lines() returns them).

occurrence is a 0-based index that disambiguates when several bullets share the same (author, text) key: 0 removes the first match, 1 the second, etc. The applier walks bullets in iter_changes_by_author order. Whitespace between surviving bullets is preserved.

Fields

§file: PathBuf

File to edit, relative to the package root.

§version: String

Version string of the target entry.

§author: Option<String>

Author header above the bullet, if any.

§text: String

Body text of the bullet (lines joined by \n).

§occurrence: usize

0-based index among bullets sharing the same (author, text) key. Defaults to 0 over the wire when omitted.

§

ReplaceBullet

Replace the body lines of a bullet, identified the same way as in RemoveBullet. new_lines are stored without their */ continuation prefix — the applier passes them straight to Bullet::replace_with, which re-adds the proper indentation.

Fields

§file: PathBuf

File to edit, relative to the package root.

§version: String

Version string of the target entry.

§author: Option<String>

Author header above the bullet, if any.

§text: String

Current body text of the bullet (lines joined by \n).

§occurrence: usize

0-based index among bullets sharing the same (author, text) key.

§new_lines: Vec<String>

Replacement body lines.

§

SetEntryVersion

Replace the version of the entry currently identified by version with new_version. A no-op if no entry has that version.

Fields

§file: PathBuf

File to edit, relative to the package root.

§version: String

Current version string of the target entry.

§new_version: String

New version string to write into the entry header.

Trait Implementations§

Source§

impl Clone for ChangelogAction

Source§

fn clone(&self) -> ChangelogAction

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 ChangelogAction

Source§

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

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

impl<'de> Deserialize<'de> for ChangelogAction

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for ChangelogAction

Source§

impl PartialEq for ChangelogAction

Source§

fn eq(&self, other: &ChangelogAction) -> 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 Serialize for ChangelogAction

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ChangelogAction

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> Ungil for T
where T: Send,

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