Skip to main content

FunctionsClient

Struct FunctionsClient 

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

HTTP client for Supabase Edge Functions.

Communicates with Edge Functions at /functions/v1/{function_name}.

§Example

use supabase_client_functions::{FunctionsClient, InvokeOptions};
use serde_json::json;

let client = FunctionsClient::new("https://your-project.supabase.co", "your-anon-key")?;
let response = client.invoke("hello", InvokeOptions::new()
    .body(json!({"name": "World"}))
).await?;
let data: serde_json::Value = response.json()?;

Implementations§

Source§

impl FunctionsClient

Source

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

Create a new Edge Functions client.

supabase_url is the project URL (e.g., https://your-project.supabase.co). api_key is the Supabase anon or service_role key.

Source

pub fn base_url(&self) -> &Url

Get the base URL for the functions endpoint.

Source

pub fn api_key(&self) -> &str

Get the API key used by this client.

Source

pub fn set_auth(&self, token: &str)

Update the default auth token for function invocations.

Subsequent invocations will use Bearer <token> unless overridden per-request.

Mirrors supabase.functions.setAuth(token).

Source

pub async fn invoke( &self, function_name: &str, options: InvokeOptions, ) -> Result<FunctionResponse, FunctionsError>

Invoke an Edge Function.

§Arguments
  • function_name - The name of the deployed function.
  • options - Invocation options (body, method, headers, region, etc.).
§Errors

Trait Implementations§

Source§

impl Clone for FunctionsClient

Source§

fn clone(&self) -> FunctionsClient

Returns a duplicate of the value. Read more
1.0.0 · 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> 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