google-cloud-pubsub 0.32.3-preview

Google Cloud Client Libraries for Rust - Pub/Sub
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use crate::publisher::builder::PublisherPartialBuilder;

/// Creates [`Publisher`](super::client::Publisher) instances.
///
/// A single `BasePublisher` can be used to create multiple `Publisher` clients
/// for different topics. It manages the underlying gRPC connection and
/// authentication.
///
/// # Example
///
/// ```
/// # async fn sample() -> anyhow::Result<()> {
/// # use google_cloud_pubsub::client::BasePublisher;
/// # use google_cloud_pubsub::model::Message;
///
/// // Create a client.
/// let client = BasePublisher::builder().build().await?;
///
/// // Create a publisher for a specific topic.
/// let publisher = client.publisher("projects/my-project/topics/my-topic").build();
///
/// // Publish a message.
/// let handle = publisher.publish(Message::new().set_data("hello world"));
/// let message_id = handle.await?;
/// println!("Message sent with ID: {}", message_id);
/// # Ok(())
/// # }
/// ```
#[derive(Clone, Debug)]
pub struct BasePublisher {
    pub(crate) inner: crate::generated::gapic_dataplane::client::Publisher,
}

/// A builder for [BasePublisher].
///
/// ```
/// # async fn sample() -> anyhow::Result<()> {
/// # use google_cloud_pubsub::*;
/// # use builder::publisher::BasePublisherBuilder;
/// # use client::BasePublisher;
/// let builder: BasePublisherBuilder = BasePublisher::builder();
/// let client = builder
///     .with_endpoint("https://pubsub.googleapis.com")
///     .build().await?;
/// # Ok(()) }
/// ```
pub use super::client_builder::ClientBuilder as BasePublisherBuilder;

impl BasePublisher {
    /// Returns a builder for [BasePublisher].
    ///
    /// ```no_run
    /// # tokio_test::block_on(async {
    /// # use google_cloud_pubsub::client::BasePublisher;
    /// let client = BasePublisher::builder().build().await?;
    /// # google_cloud_gax::client_builder::Result::<()>::Ok(()) });
    /// ```
    pub fn builder() -> BasePublisherBuilder {
        BasePublisherBuilder::new()
    }

    /// Creates a new Pub/Sub publisher client with the given configuration.
    pub(crate) async fn new(builder: BasePublisherBuilder) -> crate::ClientBuilderResult<Self> {
        let inner =
            crate::generated::gapic_dataplane::client::Publisher::new(builder.config).await?;
        std::result::Result::Ok(Self { inner })
    }

    /// Creates a new `Publisher` for a given topic.
    ///
    /// ```
    /// # async fn sample() -> anyhow::Result<()> {
    /// # use google_cloud_pubsub::*;
    /// # use builder::publisher::BasePublisherBuilder;
    /// # use client::BasePublisher;
    /// # use model::Message;
    /// let client = BasePublisher::builder().build().await?;
    /// let publisher = client.publisher("projects/my-project/topics/my-topic").build();
    /// let message_id = publisher.publish(Message::new().set_data("Hello, World")).await?;
    /// # Ok(()) }
    /// ```
    pub fn publisher<T>(&self, topic: T) -> PublisherPartialBuilder
    where
        T: Into<String>,
    {
        PublisherPartialBuilder::new(self.inner.clone(), topic.into())
    }
}

#[cfg(test)]
mod tests {
    use super::BasePublisher;
    use google_cloud_auth::credentials::anonymous::Builder as Anonymous;

    #[tokio::test]
    async fn builder() -> anyhow::Result<()> {
        let client = BasePublisher::builder()
            .with_credentials(Anonymous::new().build())
            .build()
            .await?;
        let _ = client.publisher("projects/my-project/topics/my-topic".to_string());
        Ok(())
    }
}