Merge pull request #171 from estie-inc/refactor/tidy-imports-and-doc-comments

refactor: alias std paths and reflow doc comments

Author: yuly3

benches/result_table.rs

@@ -39,8 +39,7 @@ fn materialize_dynamic_rows(table: &ResultTable) {
 }
 
 fn synthetic_chunk_bytes(row_count: usize, null_pct: u8, escaped_pct: u8) -> Bytes {
-    // remote chunk fragment shape: `[..],[..],[..]`. Each row is
-    // [int_text, string_text, timestamp_text].
+    // remote chunk fragment shape: `[..],[..],[..]`. Each row is [int_text, string_text, timestamp_text].
     let mut out = Vec::with_capacity(row_count * 64);
     for i in 0..row_count {
         if i > 0 {

derive/src/attrs.rs

@@ -9,8 +9,8 @@ pub(crate) enum RenameAll {
 pub(crate) struct ContainerAttrs {
     /// Effective field-name conversion.
     pub(crate) rename_all: RenameAll,
-    /// `true` only if the user wrote `#[snowflake(rename_all = "...")]`
-    /// explicitly. Used to reject `positional` + explicit `rename_all`.
+    /// `true` only if the user wrote `#[snowflake(rename_all = "...")]` explicitly.
+    /// Used to reject `positional` + explicit `rename_all`.
     pub(crate) rename_all_explicit: bool,
     pub(crate) positional: bool,
     pub(crate) crate_path: Path,

derive/src/input.rs

@@ -1,8 +1,10 @@
 use quote::format_ident;
 use syn::{Data, DeriveInput, Fields, Ident, Path, Result, spanned::Spanned};
 
-use crate::attrs::{ContainerAttrs, parse_container_attrs, parse_field_attrs};
-use crate::naming::{apply_rename_all, logical_ident_name};
+use crate::{
+    attrs::{ContainerAttrs, parse_container_attrs, parse_field_attrs},
+    naming::{apply_rename_all, logical_ident_name},
+};
 
 pub(crate) struct FromRowDerive {
     pub(crate) struct_ident: Ident,

src/auth/external_browser/config.rs

@@ -87,9 +87,7 @@ impl ManualRedirectConfig {
 #[derive(Clone, Debug, PartialEq, Eq)]
 /// Configuration for [`AuthConfig::external_browser`](crate::AuthConfig::external_browser).
 ///
-/// Use [`ExternalBrowserConfig::callback_listener`] or
-/// [`ExternalBrowserConfig::manual_redirect`] to choose the
-/// authentication mode.
+/// Use [`ExternalBrowserConfig::callback_listener`] or [`ExternalBrowserConfig::manual_redirect`] to choose the authentication mode.
 /// For end-to-end setup examples, see [`AuthConfig::external_browser`](crate::AuthConfig::external_browser).
 pub struct ExternalBrowserConfig {
     mode: ExternalBrowserMode,
@@ -121,12 +119,9 @@ impl ExternalBrowserConfig {
     /// This mode starts a local HTTP listener and receives the token automatically
     /// from the redirected callback URL.
     ///
-    /// - `browser_launch_mode`: controls whether the auth URL is opened automatically (`Auto`)
-    ///   or only printed for manual open (`Manual`).
-    /// - `callback_socket_addr`: bind address for the local callback listener
-    ///   (for example `127.0.0.1` or `0.0.0.0`).
-    /// - `callback_socket_port`: bind port for the callback listener.
-    ///   Use `0` to let the OS pick an available ephemeral port.
+    /// - `browser_launch_mode`: controls whether the auth URL is opened automatically (`Auto`) or only printed for manual open (`Manual`).
+    /// - `callback_socket_addr`: bind address for the local callback listener (for example `127.0.0.1` or `0.0.0.0`).
+    /// - `callback_socket_port`: bind port for the callback listener. Use `0` to let the OS pick an available ephemeral port.
     pub fn callback_listener(
         browser_launch_mode: BrowserLaunchMode,
         callback_socket_addr: IpAddr,
@@ -143,17 +138,12 @@ impl ExternalBrowserConfig {
 
     /// Creates a manual-redirect external-browser configuration.
     ///
-    /// This mode does not start a local listener. After login, paste the redirected
-    /// URL shown by the browser into the terminal prompt.
+    /// This mode does not start a local listener. After login, paste the redirected URL shown by the browser into the terminal prompt.
     ///
-    /// - `browser_launch_mode`: controls whether the auth URL is opened automatically (`Auto`)
-    ///   or only printed for manual open (`Manual`).
-    /// - `redirect_port`: port embedded in `BROWSER_MODE_REDIRECT_PORT` for Snowflake.
-    ///   No local server is started in this mode, so this port does not need to be
-    ///   actually listening.
-    ///   It is still required because Snowflake uses this value to construct the
-    ///   browser redirect URL that you later paste into the terminal; the connector
-    ///   then extracts the token from that pasted URL.
+    /// - `browser_launch_mode`: controls whether the auth URL is opened automatically (`Auto`) or only printed for manual open (`Manual`).
+    /// - `redirect_port`: port embedded in `BROWSER_MODE_REDIRECT_PORT` for Snowflake. No local server is started in this mode,
+    ///   so this port does not need to be actually listening. It is still required because Snowflake uses this value to construct
+    ///   the browser redirect URL that you later paste into the terminal; the connector then extracts the token from that pasted URL.
     pub fn manual_redirect(
         browser_launch_mode: BrowserLaunchMode,
         redirect_port: NonZeroU16,

src/auth/external_browser/manual_input_unix.rs

@@ -9,10 +9,9 @@ use crate::{Result, error::AuthError};
 pub(super) fn try_read_redirected_url_line_noncanonical() -> Option<Result<String>> {
     let stdin = io::stdin();
 
-    // We intentionally use nix termios wrappers (instead of raw libc calls) so this crate
-    // can avoid `unsafe` while still controlling TTY mode.
-    // On macOS, canonical mode has a small line-length limit (MAX_CANON), so long redirected
-    // URLs can trigger terminal bell/input rejection. Non-canonical mode avoids that limit.
+    // We intentionally use nix termios wrappers so this crate can avoid `unsafe` while still controlling TTY mode.
+    // On macOS, canonical mode has a small line-length limit (MAX_CANON), so long redirected URLs can trigger terminal
+    // bell/input rejection. Non-canonical mode avoids that limit.
     if !stdin.is_terminal() {
         // Only switch modes for interactive TTY. If stdin is redirected/piped, keep default read_line.
         return None;

src/auth/external_browser/payload.rs

@@ -27,8 +27,7 @@ impl ParsedTokenAndConsent {
 /// - callback listener flow (`GET` query / `POST` form body parsing in `listener`)
 /// - manual redirected-URL flow (query/fragment parsing in `manual_redirect_input`)
 ///
-/// Keeping this in one place guarantees both flows use identical parsing rules
-/// (case-insensitive keys, first non-empty token wins, consent parsing behavior).
+/// Keeping this in one place guarantees both flows use identical parsing rules.
 pub(crate) fn parse_token_and_consent_from_pairs<'a, I>(pairs: I) -> ParsedTokenAndConsent
 where
     I: IntoIterator<Item = (Cow<'a, str>, Cow<'a, str>)>,

src/auth/wire/login_request.rs

@@ -65,8 +65,7 @@ pub(crate) enum LoginCredentialWire<'a> {
 pub(crate) enum PasscodeWire<'a> {
     /// Sent as a separate `PASSCODE` field.
     Separate(&'a str),
-    /// The passcode is already appended to `PASSWORD`; only the method flag is
-    /// sent.
+    /// The passcode is already appended to `PASSWORD`; only the method flag is sent.
     InPassword,
 }
 

src/bind.rs

@@ -1,5 +1,4 @@
-//! Types passed to [`Statement::bind`](crate::Statement::bind) and
-//! [`Statement::bind_named`](crate::Statement::bind_named).
+//! Types passed to [`Statement::bind`](crate::Statement::bind) and [`Statement::bind_named`](crate::Statement::bind_named).
 //!
 //! Most callers reach for one of the typed wrappers.
 //! [`RawBind`] is the escape hatch when none of those fit (e.g. binding a `DECFLOAT`).

src/config.rs

@@ -67,17 +67,15 @@ pub enum EndpointConfig {
 
 /// HTTP transport-layer options.
 ///
-/// Configures how requests are physically delivered to Snowflake,
-/// independent of which endpoint they target.
+/// Configures how requests are physically delivered to Snowflake, independent of which endpoint they target.
 #[derive(Default, Clone, Debug)]
 pub struct TransportConfig {
     proxy: Option<ProxyConfig>,
 }
 
 /// Configuration for an HTTP proxy used by [`TransportConfig`].
 ///
-/// Specifies the proxy URL and optional authentication credentials.
-/// Only HTTP and HTTPS proxy schemes are accepted.
+/// Specifies the proxy URL and optional authentication credentials. Only HTTP and HTTPS proxy schemes are accepted.
 #[derive(Clone, Debug)]
 pub struct ProxyConfig {
     url: Url,

src/error/decode.rs

@@ -1,4 +1,8 @@
-use std::borrow::Cow;
+use std::{
+    borrow::Cow,
+    error::Error as StdError,
+    fmt::{self, Display},
+};
 
 use crate::result_table::{ColumnIndex, ColumnType};
 
@@ -9,12 +13,11 @@ pub type CellDecodeResult<T> = std::result::Result<T, CellConversionError>;
 
 /// Cell-local reason why decoding a value failed.
 ///
-/// This describes only the local conversion problem. Row, column, and
-/// value context live on [`CellDecodeError`].
+/// This describes only the local conversion problem. Row, column, and value context live on [`CellDecodeError`].
 #[derive(Debug)]
 pub struct CellConversionError {
     reason: Box<str>,
-    source: Option<Box<dyn std::error::Error + Send + Sync + 'static>>,
+    source: Option<Box<dyn StdError + Send + Sync + 'static>>,
 }
 
 impl CellConversionError {
@@ -29,34 +32,31 @@ impl CellConversionError {
         &self.reason
     }
 
-    pub fn source(&self) -> Option<&(dyn std::error::Error + Send + Sync + 'static)> {
+    pub fn source(&self) -> Option<&(dyn StdError + Send + Sync + 'static)> {
         self.source.as_deref()
     }
 }
 
-impl std::fmt::Display for CellConversionError {
-    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+impl Display for CellConversionError {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         f.write_str(&self.reason)
     }
 }
 
-impl std::error::Error for CellConversionError {
-    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+impl StdError for CellConversionError {
+    fn source(&self) -> Option<&(dyn StdError + 'static)> {
         self.source.as_deref().map(|source| source as _)
     }
 }
 
 #[derive(Debug)]
 pub struct CellConversionErrorBuilder {
     reason: Box<str>,
-    source: Option<Box<dyn std::error::Error + Send + Sync + 'static>>,
+    source: Option<Box<dyn StdError + Send + Sync + 'static>>,
 }
 
 impl CellConversionErrorBuilder {
-    pub fn source(
-        mut self,
-        source: impl Into<Box<dyn std::error::Error + Send + Sync + 'static>>,
-    ) -> Self {
+    pub fn source(mut self, source: impl Into<Box<dyn StdError + Send + Sync + 'static>>) -> Self {
         self.source = Some(source.into());
         self
     }
@@ -132,8 +132,8 @@ impl CellDecodeError {
     }
 }
 
-impl std::fmt::Display for CellDecodeError {
-    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+impl Display for CellDecodeError {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
         write!(
             f,
             "row_index {} column_index {:?} ({}): target_type {}, found {:?}",
@@ -153,10 +153,10 @@ impl std::fmt::Display for CellDecodeError {
     }
 }
 
-impl std::error::Error for CellDecodeError {
-    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
+impl StdError for CellDecodeError {
+    fn source(&self) -> Option<&(dyn StdError + 'static)> {
         self.issue
             .source()
-            .map(|_| &self.issue as &(dyn std::error::Error + 'static))
+            .map(|_| &self.issue as &(dyn StdError + 'static))
     }
 }