pub struct GenerateReleaseNotesBuilder<'octo, 'repos, 'handler, 'tag_name, 'previous_tag_name, 'target_commitish, 'configuration_file_path> { /* private fields */ }
Expand description

A builder pattern struct for updating releases.

created by ReleasesHandler::generate_release_notes.

Implementations§

source§

impl<'octo, 'repos, 'handler, 'tag_name, 'previous_tag_name, 'target_commitish, 'configuration_file_path> GenerateReleaseNotesBuilder<'octo, 'repos, 'handler, 'tag_name, 'previous_tag_name, 'target_commitish, 'configuration_file_path>

source

pub fn previous_tag_name( self, previous_tag_name: &'previous_tag_name (impl AsRef<str> + ?Sized) ) -> Self

The tag which is used as a starting point for the release notes.

source

pub fn target_commitish( self, target_commitish: &'target_commitish (impl AsRef<str> + ?Sized) ) -> Self

Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git GenerateReleaseNotesBuilder::tag_name exists.

source

pub fn configuration_file_path( self, configuration_file_path: &'configuration_file_path (impl AsRef<str> + ?Sized) ) -> Self

A file path within the repository which contains the configuration settings for generating release notes.

source

pub async fn send(self) -> Result<ReleaseNotes>

Sends the actual request.

Trait Implementations§

source§

impl<'octo, 'repos, 'handler, 'tag_name, 'previous_tag_name, 'target_commitish, 'configuration_file_path> Serialize for GenerateReleaseNotesBuilder<'octo, 'repos, 'handler, 'tag_name, 'previous_tag_name, 'target_commitish, 'configuration_file_path>

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§

§

impl<'octo, 'repos, 'handler, 'tag_name, 'previous_tag_name, 'target_commitish, 'configuration_file_path> Freeze for GenerateReleaseNotesBuilder<'octo, 'repos, 'handler, 'tag_name, 'previous_tag_name, 'target_commitish, 'configuration_file_path>

§

impl<'octo, 'repos, 'handler, 'tag_name, 'previous_tag_name, 'target_commitish, 'configuration_file_path> !RefUnwindSafe for GenerateReleaseNotesBuilder<'octo, 'repos, 'handler, 'tag_name, 'previous_tag_name, 'target_commitish, 'configuration_file_path>

§

impl<'octo, 'repos, 'handler, 'tag_name, 'previous_tag_name, 'target_commitish, 'configuration_file_path> Send for GenerateReleaseNotesBuilder<'octo, 'repos, 'handler, 'tag_name, 'previous_tag_name, 'target_commitish, 'configuration_file_path>

§

impl<'octo, 'repos, 'handler, 'tag_name, 'previous_tag_name, 'target_commitish, 'configuration_file_path> Sync for GenerateReleaseNotesBuilder<'octo, 'repos, 'handler, 'tag_name, 'previous_tag_name, 'target_commitish, 'configuration_file_path>

§

impl<'octo, 'repos, 'handler, 'tag_name, 'previous_tag_name, 'target_commitish, 'configuration_file_path> Unpin for GenerateReleaseNotesBuilder<'octo, 'repos, 'handler, 'tag_name, 'previous_tag_name, 'target_commitish, 'configuration_file_path>

§

impl<'octo, 'repos, 'handler, 'tag_name, 'previous_tag_name, 'target_commitish, 'configuration_file_path> !UnwindSafe for GenerateReleaseNotesBuilder<'octo, 'repos, 'handler, 'tag_name, 'previous_tag_name, 'target_commitish, 'configuration_file_path>

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> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

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

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

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

source§

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

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

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

§

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>,

§

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.
source§

impl<T> WithSubscriber for T

source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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