Enum git_object::tree::EntryMode

source ·

#[repr(u16)]
pub enum EntryMode {
    Tree,
    Blob,
    BlobExecutable,
    Link,
    Commit,
}

Expand description

The mode of items storable in a tree, similar to the file mode on a unix file system.

Used in mutable::Entry and EntryRef.

Variants§

§

Tree

A tree, or directory

§

Blob

A file that is not executable

§

BlobExecutable

A file that is executable

§

Link

A symbolic link

§

Commit

A commit of a git submodule

Implementations§

source §

impl EntryMode

source

pub fn is_tree(&self) -> bool

Return true if this entry mode represents a Tree/directory

source

pub fn is_no_tree(&self) -> bool

Return true if this entry mode represents anything BUT Tree/directory

source

pub fn is_blob(&self) -> bool

Return true if the entry is any kind of blob.

source

pub fn as_str(&self) -> &'static str

Represent the mode as descriptive string.

source §

impl EntryMode

Serialization

source

pub fn as_bytes(&self) -> &'static [u8] ⓘ

Return the representation as used in the git internal format.

Examples found in repository ?

src/tree/write.rs (line 39)

    fn write_to(&self, mut out: impl io::Write) -> io::Result<()> {
        debug_assert_eq!(
            &{
                let mut entries_sorted = self.entries.clone();
                entries_sorted.sort();
                entries_sorted
            },
            &self.entries,
            "entries for serialization must be sorted by filename"
        );
        for Entry { mode, filename, oid } in &self.entries {
            out.write_all(mode.as_bytes())?;
            out.write_all(SPACE)?;

            if filename.find_byte(b'\n').is_some() {
                return Err(Error::NewlineInFilename {
                    name: (*filename).to_owned(),
                }
                .into());
            }
            out.write_all(filename)?;
            out.write_all(&[b'\0'])?;

            out.write_all(oid.as_bytes())?;
        }
        Ok(())
    }

    fn size(&self) -> usize {
        self.entries
            .iter()
            .map(|Entry { mode, filename, oid }| mode.as_bytes().len() + 1 + filename.len() + 1 + oid.as_bytes().len())
            .sum()
    }

    fn kind(&self) -> Kind {
        Kind::Tree
    }
}

/// Serialization
impl<'a> crate::WriteTo for TreeRef<'a> {
    /// Serialize this tree to `out` in the git internal format.
    fn write_to(&self, mut out: impl io::Write) -> io::Result<()> {
        debug_assert_eq!(
            &{
                let mut entries_sorted = self.entries.clone();
                entries_sorted.sort();
                entries_sorted
            },
            &self.entries,
            "entries for serialization must be sorted by filename"
        );
        for EntryRef { mode, filename, oid } in &self.entries {
            out.write_all(mode.as_bytes())?;
            out.write_all(SPACE)?;

            if filename.find_byte(b'\n').is_some() {
                return Err(Error::NewlineInFilename {
                    name: (*filename).to_owned(),
                }
                .into());
            }
            out.write_all(filename)?;
            out.write_all(&[b'\0'])?;

            out.write_all(oid.as_bytes())?;
        }
        Ok(())
    }

    fn size(&self) -> usize {
        self.entries
            .iter()
            .map(|EntryRef { mode, filename, oid }| {
                mode.as_bytes().len() + 1 + filename.len() + 1 + oid.as_bytes().len()
            })
            .sum()
    }