UpdateFileOptions

forgejo_api::structs

Struct UpdateFileOptions

pub struct UpdateFileOptions {
    pub author: Option<Identity>,
    pub branch: Option<String>,
    pub committer: Option<Identity>,
    pub content: String,
    pub dates: Option<CommitDateOptions>,
    pub from_path: Option<String>,
    pub message: Option<String>,
    pub new_branch: Option<String>,
    pub sha: String,
    pub signoff: Option<bool>,
}

Expand description

UpdateFileOptions options for updating files

Note: author and committer are optional (if only one is given, it will be used for the other, otherwise the authenticated user will be used)

Fields§

§author: Option<Identity>§branch: Option<String>

branch (optional) to base this file from. if not given, the default branch is used

§committer: Option<Identity>§content: String

content must be base64 encoded

§dates: Option<CommitDateOptions>§from_path: Option<String>

from_path (optional) is the path of the original file which will be moved/renamed to the path in the URL

§message: Option<String>

message (optional) for the commit of this file. if not supplied, a default message will be used

§new_branch: Option<String>

new_branch (optional) will make a new branch from branch before creating the file

§sha: String

sha is the SHA for the file that already exists

§signoff: Option<bool>

Add a Signed-off-by trailer by the committer at the end of the commit log message.

Trait Implementations§

impl Clone for UpdateFileOptions

fn clone(&self) -> UpdateFileOptions

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for UpdateFileOptions

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for UpdateFileOptions

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

Deserialize this value from the given Serde deserializer. Read more

impl PartialEq for UpdateFileOptions

fn eq(&self, other: &UpdateFileOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

1.0.0 · Source§

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

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

impl Serialize for UpdateFileOptions

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

Serialize this value into the given Serde serializer. Read more

impl StructuralPartialEq for UpdateFileOptions

Auto Trait Implementations§

impl Freeze for UpdateFileOptions

impl RefUnwindSafe for UpdateFileOptions

impl Send for UpdateFileOptions

impl Sync for UpdateFileOptions

impl Unpin for UpdateFileOptions

impl UnwindSafe for UpdateFileOptions

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

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> PolicyExt for T
where T: ?Sized,

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> ErasedDestructor for T
where T: 'static,