Struct google_cloud_pubsub::subscription::Subscription

pub struct Subscription { /* private fields */ }

Subscription is a reference to a PubSub subscription.

Implementations

impl Subscription

pub fn id(&self) -> String

id returns the unique identifier of the subscription within its project.

pub fn fully_qualified_name(&self) -> &str

fully_qualified_name returns the globally unique printable name of the subscription.

pub async fn create(
    &self,
    fqtn: &str,
    cfg: SubscriptionConfig,
    cancel: Option<CancellationToken>,
    retry: Option<RetrySetting>
) -> Result<(), Status>

create creates the subscription.

pub async fn delete(
    &self,
    cancel: Option<CancellationToken>,
    retry: Option<RetrySetting>
) -> Result<(), Status>

delete deletes the subscription.

pub async fn exists(
    &self,
    cancel: Option<CancellationToken>,
    retry: Option<RetrySetting>
) -> Result<bool, Status>

exists reports whether the subscription exists on the server.

pub async fn config(
    &self,
    cancel: Option<CancellationToken>,
    retry: Option<RetrySetting>
) -> Result<(String, SubscriptionConfig), Status>

config fetches the current configuration for the subscription.

pub async fn update(
    &self,
    updating: SubscriptionConfigToUpdate,
    cancel: Option<CancellationToken>,
    retry: Option<RetrySetting>
) -> Result<(String, SubscriptionConfig), Status>

update changes an existing subscription according to the fields set in updating. It returns the new SubscriptionConfig.

pub async fn pull(
    &self,
    max_messages: i32,
    cancel: Option<CancellationToken>,
    retry: Option<RetrySetting>
) -> Result<Vec<ReceivedMessage>, Status>

pull get message synchronously. It blocks until at least one message is available.

pub async fn receive<F>(
    &self,
    f: impl Fn(ReceivedMessage, CancellationToken) -> F + Send + 'static + Sync + Clone,
    cancel: CancellationToken,
    config: Option<ReceiveConfig>
) -> Result<(), Status> where
    F: Future<Output = ()> + Send + 'static, 

receive calls f with the outstanding messages from the subscription. It blocks until cancellation token is cancelled, or the service returns a non-retryable error. The standard way to terminate a receive is to use CancellationToken.

Trait Implementations

impl Debug for Subscription

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

Formats the value using the given formatter.