Skip to content

chore(sdk): Refine comments for methods under IggyClient #1792

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

chore(sdk): Refine comments for methods under IggyClient #1792

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8e487e0
chore(sdk): Clarify comments for builder_from_connection_string
vax-r May 15, 2025
b09d531
chore(sdk): Add comment for IggyClient::from_connection_string()
vax-r May 15, 2025
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
4 changes: 3 additions & 1 deletion core/sdk/src/clients/client.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ impl IggyClient {
IggyClientBuilder::new()
}

/// Creates a new `IggyClientBuilder`.
/// Creates a new `IggyClientBuilder` from the given connection string.
pub fn builder_from_connection_string(
connection_string: &str,
) -> Result<IggyClientBuilder, IggyError> {
Expand All @@ -75,6 +75,8 @@ impl IggyClient {
}
}

/// Creates a new `IggyClient` with the provided connection string.
/// Currently only support TCP transport by default, more transports will be supported in the future.
pub fn from_connection_string(connection_string: &str) -> Result<Self, IggyError> {
let client = Box::new(TcpClient::from_connection_string(connection_string)?);
Ok(IggyClient::new(client))
Expand Down
Loading