Struct scm_record::File

pub struct File<'a> {
    pub old_path: Option<Cow<'a, Path>>,
    pub path: Cow<'a, Path>,
    pub file_mode: Option<FileMode>,
    pub sections: Vec<Section<'a>>,
}

The state of a file to be recorded.

Fields

old_path: Option<Cow<'a, Path>>

The path to the previous version of the file, for display purposes. This should be set if the file was renamed or copied from another file.

path: Cow<'a, Path>

The path to the current version of the file, for display purposes.

file_mode: Option<FileMode>

The Unix file mode of the file (before any changes), if available. This may be rendered by the UI.

This value is not directly modified by the UI; instead, construct a Section::FileMode and use the [FileState::get_file_mode] function to read a user-provided updated to the file mode function to read a user-provided updated to the file mode.

sections: Vec<Section<'a>>

The set of Sections inside the file.

Implementations

impl File<'_>

pub fn get_file_mode(&self) -> Option<FileMode>

Get the new Unix file mode. If the user selected a Section::FileMode, then returns that file mode. Otherwise, returns the file_mode value that this [FileState] was constructed with.

pub fn get_selected_contents( &self ) -> (SelectedContents<'_>, SelectedContents<'_>)

Calculate the (selected, unselected) contents of the file. For example, the first value would be suitable for staging or committing, and the second value would be suitable for potentially recording again.

pub fn tristate(&self) -> Tristate

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

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

Set the selection of all sections and lines in this file.

pub fn toggle_all(&mut self)

Toggle the selection of all sections in this file.

Trait Implementations

impl<'a> Clone for File<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for File<'a>

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

Formats the value using the given formatter.

impl<'de, 'a> Deserialize<'de> for File<'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 for File<'a>

fn eq(&self, other: &File<'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 File<'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 File<'a>

impl<'a> StructuralPartialEq for File<'a>