Skip to main content

ReviewTarget

Enum ReviewTarget 

Source
pub enum ReviewTarget {
    UncommittedChanges,
    BaseBranch {
        branch: String,
    },
    Commit {
        sha: String,
        title: Option<String>,
    },
    Custom {
        instructions: String,
    },
}
Expand description

ReviewTarget

JSON schema
{
 "oneOf": [
   {
     "title": "UncommittedChangesReviewTarget",
     "description": "Review the working tree: staged, unstaged, and untracked files.",
     "type": "object",
     "required": [
       "type"
     ],
     "properties": {
       "type": {
         "title": "UncommittedChangesReviewTargetType",
         "type": "string",
         "enum": [
           "uncommittedChanges"
         ]
       }
     }
   },
   {
     "title": "BaseBranchReviewTarget",
     "description": "Review changes between the current branch and the given base branch.",
     "type": "object",
     "required": [
       "branch",
       "type"
     ],
     "properties": {
       "branch": {
         "type": "string"
       },
       "type": {
         "title": "BaseBranchReviewTargetType",
         "type": "string",
         "enum": [
           "baseBranch"
         ]
       }
     }
   },
   {
     "title": "CommitReviewTarget",
     "description": "Review the changes introduced by a specific commit.",
     "type": "object",
     "required": [
       "sha",
       "type"
     ],
     "properties": {
       "sha": {
         "type": "string"
       },
       "title": {
         "description": "Optional human-readable label (e.g., commit subject) for UIs.",
         "type": [
           "string",
           "null"
         ]
       },
       "type": {
         "title": "CommitReviewTargetType",
         "type": "string",
         "enum": [
           "commit"
         ]
       }
     }
   },
   {
     "title": "CustomReviewTarget",
     "description": "Arbitrary instructions, equivalent to the old free-form prompt.",
     "type": "object",
     "required": [
       "instructions",
       "type"
     ],
     "properties": {
       "instructions": {
         "type": "string"
       },
       "type": {
         "title": "CustomReviewTargetType",
         "type": "string",
         "enum": [
           "custom"
         ]
       }
     }
   }
 ]
}

Variants§

§

UncommittedChanges

§

BaseBranch

BaseBranchReviewTarget

Review changes between the current branch and the given base branch.

Fields

§branch: String
§

Commit

CommitReviewTarget

Review the changes introduced by a specific commit.

Fields

§title: Option<String>

Optional human-readable label (e.g., commit subject) for UIs.

§

Custom

CustomReviewTarget

Arbitrary instructions, equivalent to the old free-form prompt.

Fields

§instructions: String

Trait Implementations§

Source§

impl Clone for ReviewTarget

Source§

fn clone(&self) -> ReviewTarget

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ReviewTarget

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ReviewTarget

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for ReviewTarget

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

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
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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
Source§

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