Skip to content

feat: re-export CodecValue and DecodedMessage at top level #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zhexuany merged 1 commit into from
Feb 8, 2026
Merged

feat: re-export CodecValue and DecodedMessage at top level #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,8 @@
//! - **[`ChannelInfo`]** - Channel/topic metadata
//! - **[`ReaderConfig`]** - Configuration for readers (parallel processing, chunk merging)
//! - **[`WriterConfig`]** - Configuration for writers
//! - **[`DecodedMessage`]** - Decoded message field name to value mapping
//! - **[`CodecValue`]** - Value type for decoded message fields
//!
//! ## S3 Authentication
//!
Expand Down Expand Up @@ -198,6 +200,9 @@ pub mod core;
// Re-export core error type for public API
pub use core::{CodecError, Result};

// Re-export core value types (decoded message representation)
pub use core::value::{CodecValue, DecodedMessage};

// Encoding/decoding (hidden from docs but available for advanced use)
#[doc(hidden)]
pub mod encoding;
Expand Down Expand Up @@ -246,8 +251,7 @@ pub use transform::{TransformBuilder, TransformError};
/// # Example
///
/// ```no_run
/// # use robocodec::{Decoder, CodecError};
/// # use robocodec::core::DecodedMessage;
/// # use robocodec::{Decoder, CodecError, DecodedMessage};
/// # struct MyDecoder;
/// # impl Decoder for MyDecoder {
/// # fn decode(&self, data: &[u8], schema: &str, type_name: Option<&str>) -> Result<DecodedMessage, CodecError> {
Expand Down Expand Up @@ -279,8 +283,7 @@ pub trait Decoder: Send + Sync {
/// # Example
///
/// ```no_run
/// # use robocodec::{Decoder, CodecError};
/// # use robocodec::core::DecodedMessage;
/// # use robocodec::{Decoder, CodecError, DecodedMessage};
/// # fn test(decoder: &dyn Decoder, data: &[u8]) -> Result<(), CodecError> {
/// let schema = "int32 value\nstring name";
/// let message = decoder.decode(data, schema, Some("test/Type"))?;
Expand Down