Struct ConnectionBuilder 

pub struct ConnectionBuilder { /* private fields */ }

Строитель для создания и настройки экземпляров Connection.

ConnectionBuilder предоставляет удобный интерфейс для настройки параметров соединения перед установлением соединения с сервером CloudPub.

Пример

use cloudpub_sdk::Connection;
use std::time::Duration;

let conn = Connection::builder()
    .config_path("/custom/config.toml")  // Пользовательский файл конфигурации
    .log_level("debug")                  // Установка уровня логирования
    .verbose(true)                       // Включить вывод в консоль
    .credentials("user@example.com", "password")  // Учетные данные для аутентификации
    .timeout(Duration::from_secs(30))    // Таймаут операций
    .build()
    .await?;

Методы аутентификации

Строитель поддерживает два метода аутентификации:

1. На основе токена: Используйте token() для аутентификации с существующим токеном
2. Учетные данные: Используйте credentials() или email()/password() для аутентификации по имени/паролю

Значения по умолчанию

• Уровень логирования: “info”
• Подробный вывод: false
• Таймаут: 10 секунд
• Путь к конфигурации: Системное расположение по умолчанию (~/.config/cloudpub/client.toml)

Implementations

impl ConnectionBuilder

pub fn new() -> Self

Создает новый builder с настройками по умолчанию.

Пример

use cloudpub_sdk::ConnectionBuilder;

let builder = ConnectionBuilder::new();

pub fn config_path<P: AsRef<Path>>(self, path: P) -> Self

Устанавливает путь к файлу конфигурации.

По умолчанию SDK ищет файл конфигурации в стандартном системном расположении. Используйте этот метод для указания пользовательского расположения.

Аргументы

• path - Путь к файлу конфигурации

Пример

use cloudpub_sdk::Connection;
use std::path::Path;

let conn = Connection::builder()
    .config_path(Path::new("/etc/cloudpub/config.toml"))
    .build()
    .await?;

pub fn log_level<S: Into<String>>(self, level: S) -> Self

Устанавливает уровень логирования для SDK.

Аргументы

• level - Уровень логирования: “trace”, “debug”, “info”, “warn”, “error”

Пример

use cloudpub_sdk::Connection;

// Включить отладочное логирование
let conn = Connection::builder()
    .log_level("debug")
    .verbose(true)  // Также выводить в консоль
    .build()
    .await?;

pub fn verbose(self, verbose: bool) -> Self

Включает или отключает подробное логирование в консоль.

При включении сообщения логов выводятся в stderr в дополнение к файлу логов. Это полезно для отладки и разработки.

Аргументы

• verbose - true для включения вывода в консоль, false для отключения

Пример

use cloudpub_sdk::Connection;

let conn = Connection::builder()
    .verbose(true)  // Включить вывод в консоль
    .build()
    .await?;

pub fn init_logging(self, init: bool) -> Self

Включает или отключает инициализацию логирования SDK.

По умолчанию build() устанавливает глобальный tracing-подписчик (tracing::subscriber::set_global_default) с записью в файл лога. Если в процессе уже установлен собственный подписчик, такая инициализация завершится ошибкой. Вызовите init_logging(false), чтобы SDK не трогал глобальное состояние логирования: события SDK попадут в подписчик приложения, а настройки log_level() и verbose() игнорируются - фильтрация остается за подписчиком приложения.

Аргументы

• init - false, чтобы использовать собственное логирование приложения

Пример

use cloudpub_sdk::Connection;

// В приложении уже настроен tracing-подписчик
let conn = Connection::builder()
    .init_logging(false)
    .build()
    .await?;

pub fn token<S: Into<String>>(self, token: S) -> Self

Устанавливает токен аутентификации.

Используйте этот метод для аутентификации на основе токена. Это взаимоисключающе с аутентификацией на основе учетных данных.

Аргументы

• token - Токен аутентификации, полученный при предыдущем входе

Пример

use cloudpub_sdk::Connection;

let conn = Connection::builder()
    .token("your-auth-token-here")
    .build()
    .await?;

pub fn credentials<S: Into<String>>(self, email: S, password: S) -> Self

Устанавливает email и пароль для аутентификации.

Используйте этот метод для аутентификации на основе учетных данных. Это взаимоисключающе с аутентификацией на основе токена.

Аргументы

• email - Email адрес пользователя
• password - Пароль пользователя

Пример

use cloudpub_sdk::Connection;

let conn = Connection::builder()
    .credentials("user@example.com", "secure-password")
    .build()
    .await?;

pub fn email<S: Into<String>>(self, email: S) -> Self

Устанавливает только email адрес.

Должен использоваться в сочетании с password(). Это полезно, когда учетные данные получаются отдельно.

Аргументы

• email - Email адрес пользователя

Пример

use cloudpub_sdk::Connection;

let conn = Connection::builder()
    .email("user@example.com")
    .password("secure-password")
    .build()
    .await?;

pub fn password<S: Into<String>>(self, password: S) -> Self

Устанавливает только пароль.

Должен использоваться в сочетании с email(). Это полезно, когда учетные данные получаются отдельно.

Аргументы

• password - Пароль пользователя

Пример

use cloudpub_sdk::Connection;

let email = std::env::var("CLOUDPUB_EMAIL")?;
let password = std::env::var("CLOUDPUB_PASSWORD")?;

let conn = Connection::builder()
    .email(email)
    .password(password)
    .build()
    .await?;

pub fn timeout(self, timeout: Duration) -> Self

Устанавливает таймаут для операций.

Этот таймаут применяется ко всем асинхронным операциям, таким как register, publish, ls и т.д. По умолчанию 10 секунд.

Аргументы

• timeout - Продолжительность таймаута операции

Пример

use cloudpub_sdk::Connection;
use std::time::Duration;

let conn = Connection::builder()
    .timeout(Duration::from_secs(60))  // Таймаут 1 минута
    .build()
    .await?;

pub fn timeout_secs(self, secs: u64) -> Self

Устанавливает таймаут в секундах.

Удобный метод для установки таймаута в секундах вместо Duration.

Аргументы

• secs - Таймаут в секундах

Пример

use cloudpub_sdk::Connection;

let conn = Connection::builder()
    .timeout_secs(30)  // Таймаут 30 секунд
    .build()
    .await?;

pub fn check_signal_fn(self, check_fn: CheckSignalFn) -> Self

Устанавливает функцию для проверки сигналов прерывания.

Это в основном используется языковыми обертками (например, Python) для проверки сигналов, таких как Ctrl+C, во время долговременных операций.

Аргументы

• check_fn - Функция, которая возвращает ошибку, если операция должна быть прервана

Пример

use cloudpub_sdk::{Connection, CheckSignalFn};
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, Ordering};

let interrupted = Arc::new(AtomicBool::new(false));
let interrupted_clone = interrupted.clone();

let check_signal: CheckSignalFn = Arc::new(move || {
    if interrupted_clone.load(Ordering::Relaxed) {
        anyhow::bail!("Operation interrupted")
    }
    Ok(())
});

let conn = Connection::builder()
    .check_signal_fn(check_signal)
    .build()
    .await?;

pub async fn build(self) -> Result<Connection>

Создает и устанавливает соединение с сервером CloudPub.

Этот метод:

1. Проверяет конфигурацию
2. Инициализирует логирование (если не отключено через init_logging(false))
3. Загружает или создает файл конфигурации
4. Аутентифицируется на сервере (если предоставлены учетные данные)
5. Устанавливает соединение
6. Ожидает готовности соединения

Возвращает

Возвращает экземпляр Connection при успехе, или ошибку, если:

• Неверная конфигурация (например, email без пароля)
• Неудачная аутентификация
• Не удается установить соединение
• Происходит таймаут

Пример

use cloudpub_sdk::Connection;

// Создание с настройками по умолчанию
let conn = Connection::builder().build().await?;

// Создание с пользовательской конфигурацией
let conn = Connection::builder()
    .credentials("user@example.com", "password")
    .log_level("debug")
    .verbose(true)
    .timeout_secs(30)
    .build()
    .await?;

Ошибки

Этот метод вернет ошибку, если:

• Email предоставлен без пароля или наоборот
• Не удалось инициализировать логирование (например, в процессе уже установлен глобальный tracing-подписчик; используйте init_logging(false))
• Не удалось загрузить или создать файл конфигурации
• Неудачная аутентификация
• Неудачное соединение с сервером
• Таймаут ожидания соединения

Trait Implementations

impl Default for ConnectionBuilder

fn default() -> Self

Returns the “default value” for a type.