golem-rust 3.0.0-rc5

Golem Rust tooling library that facilitates writing Golem backends in Rust
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

// Copyright 2024-2026 Golem Cloud
//
// 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
//
//     http://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::bindings::golem::websocket::client::{
    Error, Message, WebsocketConnection as RawWebsocketConnection,
};

pub use crate::bindings::golem::websocket::client::{
    CloseInfo as WebSocketCloseInfo, Error as WebSocketError, Message as WebSocketMessage,
    ReconstructionPolicy as WebSocketReconstructionPolicy,
};

/// A WebSocket connection with both blocking and async receive methods.
pub struct WebsocketConnection {
    inner: RawWebsocketConnection,
}

impl WebsocketConnection {
    /// Connect to a WebSocket server at the given URL (ws:// or wss://).
    /// Optional headers for auth, subprotocols, etc.
    pub fn connect(
        url: &str,
        headers: Option<Vec<(String, String)>>,
        reconstruction_policy: Option<WebSocketReconstructionPolicy>,
    ) -> Result<Self, Error> {
        RawWebsocketConnection::connect(url, headers.as_deref(), reconstruction_policy)
            .map(|inner| Self { inner })
    }

    /// Send a message (text or binary).
    pub fn send(&self, message: &Message) -> Result<(), Error> {
        self.inner.send(message)
    }

    /// Receive the next message, blocking until one is available.
    pub fn blocking_receive(&self) -> Result<Message, Error> {
        wit_bindgen::block_on(async move { self.inner.receive().await })
    }

    /// Receive the next message, blocking with a timeout in milliseconds.
    /// Returns `None` if the timeout expires before a message arrives.
    pub fn blocking_receive_with_timeout(&self, timeout_ms: u64) -> Result<Option<Message>, Error> {
        wit_bindgen::block_on(async move { self.inner.receive_with_timeout(timeout_ms).await })
    }

    /// Receive the next message asynchronously.
    /// Yields the current task until a message is available.
    pub async fn receive(&self) -> Result<Message, Error> {
        self.inner.receive().await
    }

    /// Receive the next message asynchronously with a timeout in milliseconds.
    /// Yields the current task; returns `None` if the timeout expires before a message arrives.
    pub async fn receive_with_timeout(&self, timeout_ms: u64) -> Result<Option<Message>, Error> {
        self.inner.receive_with_timeout(timeout_ms).await
    }

    /// Send a close frame with optional code and reason.
    pub fn close(&self, code: Option<u16>, reason: Option<String>) -> Result<(), Error> {
        self.inner.close(code, reason.as_deref())
    }
}