[−][src]Struct octocrab::OctocrabBuilder
A builder struct for Octocrab
, allowing you to configure the client, such
as using GitHub previews, the github instance, authentication, etc.
let octocrab = octocrab::OctocrabBuilder::new() .add_preview("machine-man") .base_url("https://github.example.com")? .build()?;
Implementations
impl OctocrabBuilder
[src]
pub fn new() -> Self
[src]
pub fn add_preview(self, preview: &'static str) -> Self
[src]
Enable a GitHub preview.
pub fn personal_token(self, token: String) -> Self
[src]
Add a personal token to use for authentication.
pub fn base_url(self, base_url: impl IntoUrl) -> Result<Self>
[src]
Set the base url for Octocrab
.
pub fn build(self) -> Result<Octocrab>
[src]
Create the Octocrab
client.
Trait Implementations
impl Default for OctocrabBuilder
[src]
pub fn default() -> OctocrabBuilder
[src]
Auto Trait Implementations
impl RefUnwindSafe for OctocrabBuilder
[src]
impl Send for OctocrabBuilder
[src]
impl Sync for OctocrabBuilder
[src]
impl Unpin for OctocrabBuilder
[src]
impl UnwindSafe for OctocrabBuilder
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,