cloudpub-sdk

Rust SDK для CloudPub - платформы безопасной публикации локальных сервисов в интернете.

О библиотеке

cloudpub-sdk предоставляет программный интерфейс для интеграции функциональности CloudPub в ваши Rust приложения. SDK позволяет публиковать локальные сервисы, управлять туннелями и контролировать доступ программным способом.

Возможности

Простая интеграция: Минималистичный API для быстрого старта
Асинхронная работа: Полная поддержка async/await на базе Tokio
Управление публикациями: Создание, запуск, остановка и удаление публикаций
Безопасность: Встроенная поддержка TLS и управления доступом
Типобезопасность: Строгая типизация всех операций
Мониторинг: Встроенная поддержка трассировки через tracing

Установка

Добавьте в Cargo.toml:

[dependencies]
cloudpub-sdk = "2.4.2"
tokio = { version = "1", features = ["full"] }

Быстрый старт

Пример использования

use anyhow::Result;
use cloudpub_common::protocol::{Auth, Protocol};
use cloudpub_sdk::Connection;
use std::path::Path;

#[tokio::main]
async fn main() -> Result<()> {
    // Создание подключения с использованием builder pattern
    let mut conn = Connection::builder()
        .config_path(Path::new("/tmp/cloudpub.toml"))  // Путь к файлу конфигурации
        .log_level("info")                              // Уровень логирования
        .verbose(true)                                  // Вывод отладочной информации
        .credentials("user@example.com", "password")    // Учетные данные
        .timeout_secs(30)                               // Таймаут операций
        .build()
        .await?;

    // Публикация HTTP сервиса
    let endpoint = conn
        .publish(
            Protocol::Http,                         // Протокол
            "localhost:8080".to_string(),           // Локальный адрес
            Some("Мой веб-сервис".to_string()),    // Имя сервиса
            Some(Auth::None),                       // Без авторизации
        )
        .await?;

    println!("Сервис опубликован: {}", endpoint.as_url());
    println!("GUID сервиса: {}", endpoint.guid);

    // Получение списка всех сервисов
    let services = conn.ls().await?;
    for service in &services {
        println!("- {}: {}", service.guid, service.as_url());
    }

    // Остановка сервиса
    conn.stop(endpoint.guid.clone()).await?;
    println!("Сервис остановлен");

    // Запуск сервиса
    conn.start(endpoint.guid.clone()).await?;
    println!("Сервис запущен");

    // Удаление сервиса
    conn.unpublish(endpoint.guid.clone()).await?;
    println!("Сервис удален");

    // Очистка всех сервисов
    conn.clean().await?;
    println!("Все сервисы удалены");

    Ok(())
}

API Reference

Основные типы

`Connection`

Основной клиент для взаимодействия с CloudPub.

`Endpoint`

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

`Protocol`

Enum с поддерживаемыми протоколами: Http, Https, Tcp, Udp, OneC, WebDav, Minecraft.

`Auth`

Типы авторизации: None, Basic.

Примеры

Пример использования доступны в директории examples/:

# Запуск примера
cargo run --example example

Лицензия

Apache License 2.0

cloudpub-sdk 2.4.3