liminal-sdk 0.19.1

Application-facing SDK traits for liminal messaging clients
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

#![cfg_attr(not(feature = "std"), no_std)]

extern crate alloc;

pub mod channel;
pub mod connection;
pub mod conversation;
pub mod embedded;
pub mod error;
pub mod pressure;
pub mod remote;
pub mod types;

pub use channel::ChannelHandle;
pub use connection::{
    ConnectionEvent, ConnectionEvents, ConnectionLifecycle, ConnectionPool, ConnectionPoolConfig,
    ConnectionState, DisconnectReason, PoolConnectionId, ResumeRequest, SubscriptionAssignment,
    SubscriptionId, SubscriptionRecovery,
};
pub use conversation::{ConversationEvent, ConversationHandle, ConversationId};
pub use embedded::{EmbeddedChannelHandle, EmbeddedConfig, EmbeddedConversationHandle};
pub use error::SdkError;
#[cfg(feature = "std")]
pub use liminal::protocol::ProtocolVersion;
pub use pressure::{DeliveryAck, PressureResponse};
#[cfg(all(feature = "std", unix))]
pub use remote::ReadWake;
pub use remote::{
    CredentialAttachReissueReason, LostCredentialAttachRefusalReason, PARTICIPANT_PUMP_WINDOW,
    ParticipantPumpDiagnostics, ParticipantResponseProvenance, ParticipantResumeStore,
    RecordAdmissionFate, RemoteChannelHandle, RemoteConfig, RemoteConversationHandle,
    RemoteCredentialAttachRecovery, RemoteDetachReplayOutcome, RemoteExpectedOperationRecovery,
    RemoteLostOperationResolution, RemoteLostReconnectResolution, RemoteOperationRecordOutcome,
    RemoteOperationTransportFate, RemoteParticipantError, RemoteParticipantHandle,
    RemoteParticipantInbound, RemoteParticipantOperation, RemoteParticipantSendOutcome,
    RemoteReconnectAttemptOutcome, RemoteReconnectPermit, RemoteReconnectPermitOutcome,
    RemoteReconnectPermitRecovery, RemoteReplayApplyOutcome, RemoteTransportLossOutcome,
    SdkChannelHandle, SdkConfig, SdkConversationHandle, ServerAddress, build_channel_handle,
    build_conversation_handle,
};
#[cfg(feature = "std")]
pub use remote::{
    DEFAULT_PUSH_MAILBOX_BYTES, DEFAULT_PUSH_MAILBOX_FRAMES, DEFAULT_SUBSCRIPTION_MAILBOX_BYTES,
    DEFAULT_SUBSCRIPTION_MAILBOX_FRAMES, DeliveredMessage, FlushMode, FlushOutcome,
    MailboxOverflow, MailboxStats, OBSERVABILITY_CHANNEL, PublishRejection, PushClient,
    PushCloseCause, PushReceiveOutcome, PushReceiver, PushWriter, PushedFrame, SubscriptionStream,
    WebSocketDeliveredMessage, WebSocketRemoteTransport, WebSocketSubscriptionStream,
};
pub use types::{SchemaMetadata, SchemaValidate};

/// Frames a Lys pass token as the credential a `Connect` carries.
///
/// ACCESS-001 R2: the Lys record tag, then the token exactly as Lys issued
/// it. A `WirePassV1` keeps its own record; the two are never combined.
#[must_use]
pub fn lys_pass_credential(token: &str) -> Vec<u8> {
    liminal_protocol::credential::WireCredential::lys_record(token.trim().as_bytes())
}