Struct gix::Object

pub struct Object<'repo> {
    pub id: ObjectId,
    pub kind: Kind,
    pub data: Vec<u8>,
    /* private fields */
}

A decoded object with a reference to its owning repository.

Fields

id: ObjectId

The id of the object

kind: Kind

The kind of the object

data: Vec<u8>

The fully decoded object data

Implementations

impl<'repo> Object<'repo>

pub fn peel_to_kind(self, kind: Kind) -> Result<Self, Error>

Follow tags to their target and commits to trees until the given kind of object is encountered.

Note that this object doesn’t necessarily have to be the end of the chain. Typical values are Kind::Commit or Kind::Tree.

pub fn peel_to_tree(self) -> Result<Tree<'repo>, Error>

Peel this object into a tree and return it, if this is possible.

pub fn peel_tags_to_end(self) -> Result<Self, Error>

Follow all tag object targets until a commit, tree or blob is reached.

Note that this method is different from peel_to_kind(…) as it won’t peel commits to their tree, but handles tags only.

impl<'repo> Object<'repo>

Consuming conversions to attached object kinds.

pub fn into_tree(self) -> Tree<'repo>

Transform this object into a tree, or panic if it is none.

pub fn into_commit(self) -> Commit<'repo>

Transform this object into a commit, or panic if it is none.

pub fn into_tag(self) -> Tag<'repo>

Transform this object into a tag, or panic if it is none.

pub fn try_into_commit(self) -> Result<Commit<'repo>, Error>

Transform this object into a commit, or return it as part of the Err if it is no commit.

pub fn try_into_tag(self) -> Result<Tag<'repo>, Error>

Transform this object into a tag, or return it as part of the Err if it is no commit.

pub fn try_into_tree(self) -> Result<Tree<'repo>, Error>

Transform this object into a tree, or return it as part of the Err if it is no tree.

impl<'repo> Object<'repo>

pub fn detached(&self) -> ObjectDetached

Create an owned instance of this object, copying our data in the process.

pub fn detach(self) -> ObjectDetached

Sever the connection to the Repository and turn this instance into a standalone object.

impl<'repo> Object<'repo>

Conversions to detached, lower-level object types.

pub fn to_commit_ref(&self) -> CommitRef<'_>

Obtain a fully parsed commit whose fields reference our data buffer,

Panic

• this object is not a commit
• the commit could not be decoded

pub fn try_to_commit_ref(&self) -> Result<CommitRef<'_>, Error>

Obtain a fully parsed commit whose fields reference our data buffer.

pub fn to_commit_ref_iter(&self) -> CommitRefIter<'_>

Obtain an iterator over commit tokens like in to_commit_iter().

Panic

• this object is not a commit

pub fn try_to_commit_ref_iter(&self) -> Option<CommitRefIter<'_>>

Obtain a commit token iterator from the data in this instance, if it is a commit.

pub fn to_tag_ref_iter(&self) -> TagRefIter<'_>

Obtain a tag token iterator from the data in this instance.

Panic

• this object is not a tag

pub fn try_to_tag_ref_iter(&self) -> Option<TagRefIter<'_>>

Obtain a tag token iterator from the data in this instance.

Panic

• this object is not a tag

pub fn to_tag_ref(&self) -> TagRef<'_>

Obtain a tag object from the data in this instance.

Panic

• this object is not a tag
• the tag could not be decoded

pub fn try_to_tag_ref(&self) -> Result<TagRef<'_>, Error>

Obtain a fully parsed tag object whose fields reference our data buffer.

pub fn id(&self) -> Id<'repo>

Return the attached id of this object.

Trait Implementations

impl<'repo> AsRef<[u8]> for Object<'repo>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<'r> Debug for Object<'r>

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

Formats the value using the given formatter.

impl<'a> Drop for Object<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'repo> From<Commit<'repo>> for Object<'repo>

fn from(v: Commit<'repo>) -> Self

Converts to this type from the input type.

impl<'repo> From<Object<'repo>> for ObjectDetached

fn from(v: Object<'repo>) -> Self

Converts to this type from the input type.

impl<'repo> PartialEq<Object<'repo>> for Id<'repo>

fn eq(&self, other: &Object<'repo>) -> 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<'repo> TryFrom<Object<'repo>> for Commit<'repo>

type Error = Object<'repo>

The type returned in the event of a conversion error.

fn try_from(value: Object<'repo>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'repo> TryFrom<Object<'repo>> for Tag<'repo>

type Error = Object<'repo>

The type returned in the event of a conversion error.

fn try_from(value: Object<'repo>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'repo> TryFrom<Object<'repo>> for Tree<'repo>

type Error = Object<'repo>

The type returned in the event of a conversion error.

fn try_from(value: Object<'repo>) -> Result<Self, Self::Error>

Performs the conversion.