Skip to main content

Crate flare_proto

Crate flare_proto 

Source
Expand description

Shared protobuf model types for Flare IM.

flare-proto exposes the common wire contracts used by Flare services and SDK infrastructure: messages, message content, conversations, sync payloads, metadata, notifications, push envelopes, event-bus envelopes, and data packets.

The crate intentionally contains common model types only. gRPC service definitions and tonic-generated clients/servers are published separately by flare-grpc-proto.

§Main Modules

  • common re-exports generated flare.common.v1 protobuf types.
  • response provides helpers for packing prost_types::Any.
  • metadata_builder provides ergonomic constructors for pagination, filters, actor context, device context, audit context, sorting, and time ranges.
  • message_content_ext provides encoding and decoding helpers for typed message content.

§Build Behavior

The crate uses prost-build with a vendored protoc binary, so downstream users and docs.rs can build it without installing a system protobuf compiler.

Re-exports§

pub use common::push_envelope;
pub use message_content_ext::MessageContentExt;
pub use message_content_ext::decode_message_content;
pub use message_content_ext::encode_message_content;
pub use response::pack_any;
pub use metadata_builder::actor_service;
pub use metadata_builder::actor_system;
pub use metadata_builder::actor_tenant_admin;
pub use metadata_builder::actor_user;
pub use metadata_builder::actor_with_attributes;
pub use metadata_builder::actor_with_roles;
pub use metadata_builder::audit_context;
pub use metadata_builder::device_context;
pub use metadata_builder::device_with_priority_critical;
pub use metadata_builder::device_with_priority_high;
pub use metadata_builder::device_with_priority_low;
pub use metadata_builder::filter_contains;
pub use metadata_builder::filter_eq;
pub use metadata_builder::filter_ge;
pub use metadata_builder::filter_gt;
pub use metadata_builder::filter_in;
pub use metadata_builder::filter_le;
pub use metadata_builder::filter_lt;
pub use metadata_builder::filter_ne;
pub use metadata_builder::filter_not_in;
pub use metadata_builder::pagination;
pub use metadata_builder::pagination_first;
pub use metadata_builder::pagination_with_more;
pub use metadata_builder::sort_asc;
pub use metadata_builder::sort_desc;
pub use metadata_builder::time_range;
pub use metadata_builder::unix_millis_from_seconds;
pub use common::AckPayload;
pub use common::AppCardAction;
pub use common::AppCardContent;
pub use common::AudioContent;
pub use common::AudioInfo;
pub use common::AuditContext;
pub use common::CapabilityPacket;
pub use common::CardContent;
pub use common::ConflictResolution;
pub use common::ConnectionQuality;
pub use common::ContentVisibility;
pub use common::ConversationDetailSync;
pub use common::ConversationDetailSyncRes;
pub use common::ConversationParticipant;
pub use common::ConversationParticipantsSync;
pub use common::ConversationParticipantsSyncRes;
pub use common::ConversationSummary as ConversationSummaryProto;
pub use common::ConversationSyncSlice;
pub use common::ConversationUserSettingsSync;
pub use common::ConversationUserSettingsSyncRes;
pub use common::ConversationVersion;
pub use common::ConversationsSync;
pub use common::ConversationsSyncRes;
pub use common::CustomContent;
pub use common::CustomPayload;
pub use common::DataPacket;
pub use common::DeleteType;
pub use common::DeviceState as ConversationDeviceState;
pub use common::EventBusEnvelope;
pub use common::FileContent;
pub use common::ForwardContent;
pub use common::ForwardItem;
pub use common::ForwardMode;
pub use common::GetSyncCursorSync;
pub use common::GetSyncCursorSyncRes;
pub use common::ImageContent;
pub use common::ImageInfo;
pub use common::LocationContent;
pub use common::MarkType;
pub use common::MediaAttachment;
pub use common::Mention;
pub use common::Message;
pub use common::MessageContent;
pub use common::MessageReadRecord;
pub use common::MessageRetentionExpiredEvent;
pub use common::MessageRetentionLifecycle;
pub use common::MessageRetentionPolicy;
pub use common::MessageRetentionPurgedEvent;
pub use common::MessageRetentionScheduledEvent;
pub use common::MessageRetentionState;
pub use common::MessageSource;
pub use common::MessageStatus;
pub use common::MessageTimeline;
pub use common::MessageType;
pub use common::MqEnvelope;
pub use common::MqPayloadKind;
pub use common::MultiConversationSync;
pub use common::MultiConversationSyncRes;
pub use common::MultiDeviceCursor;
pub use common::NotificationContent;
pub use common::NotificationPayload;
pub use common::OfflinePushInfo;
pub use common::Pagination;
pub use common::PresenceHintPacket;
pub use common::PushDelivered;
pub use common::PushEnvelope;
pub use common::PushFailed;
pub use common::PushOptions;
pub use common::PushPayloadKind;
pub use common::PushResult;
pub use common::PushTargetType;
pub use common::PushTaskEnvelope;
pub use common::PushTaskPayloadKind;
pub use common::QueryEventsSync;
pub use common::QueryEventsSyncRes;
pub use common::ReactionAction;
pub use common::RealtimeControlPacket;
pub use common::RetentionMode;
pub use common::RetentionTrigger;
pub use common::SendAccepted;
pub use common::SendAck;
pub use common::SendAckDurability;
pub use common::SingleConversationSync;
pub use common::SingleConversationSyncRes;
pub use common::Sync;
pub use common::SyncRes;
pub use common::SyncSkipItem;
pub use common::SyncSliceItem;
pub use common::SyncTombstoneItem;
pub use common::SystemPayload;
pub use common::TextContent;
pub use common::TypingStatePacket;
pub use common::UpdateSyncCursorSync;
pub use common::UpdateSyncCursorSyncRes;
pub use common::VideoContent;
pub use common::VideoInfo;

Modules§

common
flare
message_content_ext
MessageContent 扩展方法
metadata_builder
Convenience builders aligned with metadata.proto. 元数据/上下文类型的便捷构建
response
Convenience builders for prost_types::Any. flare-proto 辅助:Any 打包工具。