Struct git_checks_core::Commit

source · [−]

pub struct Commit {
    pub sha1: CommitId,
    pub message: String,
    pub parents: Vec<CommitId>,
    pub diffs: Vec<DiffInfo>,
    pub author: Identity,
    pub committer: Identity,
    /* private fields */
}

Expand description

Representation of a commit with information useful for commit checks.

Fields

sha1: CommitId

The SHA1 of the commit.

message: String

The commit message.

parents: Vec<CommitId>

The parents of the commit.

diffs: Vec<DiffInfo>

Information about files that changed in this commit.

author: Identity

The identity of the author.

committer: Identity

The identity of the commiter.

Implementations

source

impl Commit

source

pub fn new(ctx: &GitContext, sha1: &CommitId) -> Result<Self, CommitError>

Create a new commit from the given context for the SHA1.

source

pub fn file_patch(&self, path: P) -> Result<String, CommitError> where
P: AsRef<OsStr>,

Get the patch difference for the given path.

Trait Implementations

source

impl Content for Commit

source

fn workarea(&self, ctx: &GitContext) -> Result<GitWorkArea, WorkAreaError>

A workarea which may be used to work on the content.

source

fn sha1(&self) -> Option<&CommitId>

The SHA1 of the commit (if the content is of a commit).

source

fn diffs(&self) -> &Vec<DiffInfo>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

The differences in the content.

source

fn path_diff(&self, path: &FileName) -> Result<String, CommitError>

Get the patch difference for the given path.

source

fn modified_files(&self) -> Vec<&FileName>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

Return a vector of files modified in a diff. Read more

source

impl Debug for Commit

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl RefUnwindSafe for Commit

impl Send for Commit

impl Sync for Commit

impl Unpin for Commit

impl UnwindSafe for Commit

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

pub const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

pub unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct git_checks_core::Commit

Fields

Implementations

impl Commit

pub fn new(ctx: &GitContext, sha1: &CommitId) -> Result<Self, CommitError>

pub fn file_patch<P>(&self, path: P) -> Result<String, CommitError> where P: AsRef<OsStr>,

Trait Implementations

impl Content for Commit

fn workarea(&self, ctx: &GitContext) -> Result<GitWorkArea, WorkAreaError>

fn sha1(&self) -> Option<&CommitId>

fn diffs(&self) -> &Vec<DiffInfo>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

fn path_diff(&self, path: &FileName) -> Result<String, CommitError>

fn modified_files(&self) -> Vec<&FileName>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where A: Allocator,

impl Debug for Commit

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

Auto Trait Implementations

impl RefUnwindSafe for Commit

impl Send for Commit

impl Sync for Commit

impl Unpin for Commit

impl UnwindSafe for Commit

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Pointable for T

pub const ALIGN: usize

type Init = T

pub unsafe fn init(init: <T as Pointable>::Init) -> usize

pub unsafe fn deref<'a>(ptr: usize) -> &'a T

pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

pub unsafe fn drop(ptr: usize)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

pub fn file_patch<P>(&self, path: P) -> Result<String, CommitError> where
P: AsRef<OsStr>,

fn diffs(&self) -> &Vec<DiffInfo>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

fn modified_files(&self) -> Vec<&FileName>ⓘNotable traits for Vec<u8, A>`impl<A> Write for Vec<u8, A> where A: Allocator,`

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,