Skip to main content

FunctionsClient

Struct FunctionsClient 

Source
pub struct FunctionsClient { /* private fields */ }
Expand description

Client for Supabase Edge Functions at {project}/functions/v1/.

Cloning is cheap: the HTTP connection pool is shared.

Implementations§

Source§

impl FunctionsClient

Source

pub fn new(project_url: &Url, api_key: &str) -> Result<Self, FunctionsError>

Creates a client for the project base URL, for example https://abc.supabase.co/.

The client sends apikey on every request. Legacy JWT keys are also sent as Authorization: Bearer <api_key>; new-format keys (sb_publishable_..., sb_secret_...) are not.

The built-in HTTP client follows redirects only within the same origin (scheme, host, port), up to 10 hops, so credentials never reach another host.

§Errors

Returns an error when the URL cannot hold a path, the key is not a valid header value, or the HTTP client cannot be built.

Source

pub fn new_with_client( project_url: &Url, api_key: &str, http: Client, ) -> Result<Self, FunctionsError>

Same as Self::new, but reuses the given HTTP client and its connection pool.

§Errors

Returns an error when the URL cannot hold a path or the key is not a valid header value.

Source

pub fn with_access_token(&self, token: &str) -> Result<Self, FunctionsError>

Returns a copy of the client that sends Authorization: Bearer <token>.

Use this to call functions as a signed-in user.

§Errors

Returns an error when the token is not a valid header value.

Source

pub fn invoke(&self, name: &str) -> InvokeBuilder

Starts a request to the function name. The default method is POST.

The name must be non-empty, must not be . or .., and must not contain /, tab, CR, or LF. The builder reports an invalid name when you call InvokeBuilder::send.

Trait Implementations§

Source§

impl Clone for FunctionsClient

Source§

fn clone(&self) -> Self

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 FunctionsClient

Source§

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

Formats the value using the given formatter. 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> ErasedDestructor for T
where T: 'static,

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: Sized + 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: Sized + 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 = !

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

fn try_from(value: U) -> Result<T, !>

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