Enum scm_record::Section

pub enum Section<'a> {
    Unchanged {
        lines: Vec<Cow<'a, str>>,
    },
    Changed {
        lines: Vec<SectionChangedLine<'a>>,
    },
    FileMode {
        is_checked: bool,
        before: FileMode,
        after: FileMode,
    },
    Binary {
        is_checked: bool,
        old_description: Option<Cow<'a, str>>,
        new_description: Option<Cow<'a, str>>,
    },
}

A section of a file to be rendered and recorded.

Variants

Unchanged

Fields

lines: Vec<Cow<'a, str>>

The contents of the lines, including their trailing newline character(s), if any.

This section of the file is unchanged and just used for context.

By default, only part of the context will be shown. However, all of the context lines should be provided so that they can be used to globally number the lines correctly.

Changed

Fields

lines: Vec<SectionChangedLine<'a>>

The contents of the lines, including their trailing newline character(s), if any.

This section of the file is changed, and the user needs to select which specific changed lines to record.

FileMode

Fields

is_checked: bool

Whether or not the file mode change was selected for inclusion in the UI.

before: FileMode

The old file mode.

after: FileMode

The new file mode.

This indicates that the Unix file mode of the file changed, and that the user needs to accept that mode change or not. This is not part of the “contents” of the file per se, but it’s rendered inline as if it were.

Binary

Fields

is_checked: bool

Whether or not the binary contents change was selected for inclusion in the UI.

old_description: Option<Cow<'a, str>>

The description of the old binary contents, for use in the UI only.

new_description: Option<Cow<'a, str>>

The description of the new binary contents, for use in the UI only.

This file contains binary contents.

Implementations

impl Section<'_>

pub fn is_editable(&self) -> bool

Whether or not this section contains user-editable content (as opposed to simply contextual content).

pub fn tristate(&self) -> Tristate

Get the tristate value of this section. If there are no items in this section, returns Tristate::False.

pub fn set_checked(&mut self, checked: bool)

Select or unselect all items in this section.

pub fn toggle_all(&mut self)

Toggle the selection of this section.

Trait Implementations

impl<'a> Clone for Section<'a>

fn clone(&self) -> Section<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Section<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for Section<'a>

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

Deserialize this value from the given Serde deserializer.

impl<'a> PartialEq<Section<'a>> for Section<'a>

fn eq(&self, other: &Section<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a> Serialize for Section<'a>

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

Serialize this value into the given Serde serializer.

impl<'a> Eq for Section<'a>

impl<'a> StructuralEq for Section<'a>

impl<'a> StructuralPartialEq for Section<'a>