Skip to main content

ConfluenceClient

Struct ConfluenceClient 

Source
pub struct ConfluenceClient { /* private fields */ }

Implementations§

Source§

impl ConfluenceClient

Source

pub fn new(base_url: impl Into<String>, auth: ConfluenceAuth) -> Self

Source

pub fn with_http_client(self, http: Client) -> Self

Source

pub fn base_url(&self) -> &str

Source

pub fn auth(&self) -> &ConfluenceAuth

Source

pub fn with_api_version(self, api_version: Option<&str>) -> Self

Source

pub fn with_proxy(self, headers: HashMap<String, String>) -> Self

Configure proxy mode with headers added to every request. When proxy is active, provider auth headers are suppressed.

Source

pub fn rest_api_url(&self, path: &str) -> String

Source

pub async fn get_json<T>(&self, path: &str) -> Result<T>

Source

pub async fn post_json<T, B>(&self, path: &str, body: &B) -> Result<T>

Source

pub async fn put_json<T, B>(&self, path: &str, body: &B) -> Result<T>

Source

pub async fn post_empty_json<B>(&self, path: &str, body: &B) -> Result<()>
where B: Serialize + ?Sized,

Source

pub async fn delete_empty(&self, path: &str) -> Result<()>

Trait Implementations§

Source§

impl Clone for ConfluenceClient

Source§

fn clone(&self) -> ConfluenceClient

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 ConfluenceClient

Source§

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

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

impl KnowledgeBaseProvider for ConfluenceClient

Source§

fn provider_name(&self) -> &'static str

Get the provider name for logging (e.g. “confluence”).
Source§

fn get_spaces<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<ProviderResult<KbSpace>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

List available spaces / knowledge base containers.
Source§

fn list_pages<'life0, 'async_trait>( &'life0 self, params: ListPagesParams, ) -> Pin<Box<dyn Future<Output = Result<ProviderResult<KbPage>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

List pages in a space with pagination.
Source§

fn get_page<'life0, 'life1, 'async_trait>( &'life0 self, page_id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<KbPageContent>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Fetch a single page with full body content and metadata.
Source§

fn create_page<'life0, 'async_trait>( &'life0 self, params: CreatePageParams, ) -> Pin<Box<dyn Future<Output = Result<KbPage>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Create a new page.
Source§

fn update_page<'life0, 'async_trait>( &'life0 self, params: UpdatePageParams, ) -> Pin<Box<dyn Future<Output = Result<KbPage>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Update an existing page.
Source§

fn search<'life0, 'async_trait>( &'life0 self, params: SearchKbParams, ) -> Pin<Box<dyn Future<Output = Result<ProviderResult<KbPage>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Search pages across spaces or within a specific space.

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.

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