Skip to content

Commit

Permalink
codewide: appease clippy again
Browse files Browse the repository at this point in the history
This time it got angry about bad indentation in docstrings' lists.
  • Loading branch information
wprzytula committed Jul 29, 2024
1 parent 21ef1f4 commit 3c33c1d
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 11 deletions.
1 change: 1 addition & 0 deletions scylla/src/macros.rs
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ pub use scylla_cql::macros::IntoUserType;
/// - serialization will succed if suffix of UDT fields is missing. If there are missing fields in the
/// middle it will fail. Note that if "skip_name_checks" is enabled, and the types happen to match,
/// it is possible for serialization to succeed with unexpected result.
///
/// This behavior is the default to support ALTERing UDTs by adding new fields.
/// You can require exact match of fields using `force_exact_match` attribute.
///
Expand Down
18 changes: 9 additions & 9 deletions scylla/src/statement/prepared_statement.rs
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,16 @@ use crate::transport::partitioner::{Partitioner, PartitionerHasher, PartitionerN
///
/// Benefits that prepared statements have to offer:
/// * Performance - a prepared statement holds information about metadata
/// that allows to carry out a statement execution in a type safe manner.
/// When [`Session::query`](crate::transport::session::Session::query) is called with
/// non-empty bound values, the driver has to prepare the statement before execution (to provide type safety).
/// This implies 2 round trips per [`Session::query`](crate::transport::session::Session::query).
/// On the other hand, the cost of [`Session::execute`](crate::transport::session::Session::execute) is only 1 round trip.
/// that allows to carry out a statement execution in a type safe manner.
/// When [`Session::query`](crate::transport::session::Session::query) is called with
/// non-empty bound values, the driver has to prepare the statement before execution (to provide type safety).
/// This implies 2 round trips per [`Session::query`](crate::transport::session::Session::query).
/// On the other hand, the cost of [`Session::execute`](crate::transport::session::Session::execute) is only 1 round trip.
/// * Increased type-safety - bound values' types are validated with
/// the [`PreparedMetadata`] received from the server during the serialization.
/// the [`PreparedMetadata`] received from the server during the serialization.
/// * Improved load balancing - thanks to statement metadata, the driver is able
/// to compute a set of destined replicas for the statement execution. These replicas
/// will be preferred when choosing the node (and shard) to send the request to.
/// to compute a set of destined replicas for the statement execution. These replicas
/// will be preferred when choosing the node (and shard) to send the request to.
/// * Result deserialization optimization - see [`PreparedStatement::set_use_cached_result_metadata`].
///
/// # Clone implementation
Expand Down Expand Up @@ -81,7 +81,7 @@ use crate::transport::partitioner::{Partitioner, PartitionerHasher, PartitionerN
/// This raises two issues:
/// * bound values serialization errors - since [`PreparedMetadata`] is not updated
/// * result deserialization errors - when [`PreparedStatement::set_use_cached_result_metadata`] is enabled,
/// since [`ResultMetadata`] is not updated
/// since [`ResultMetadata`] is not updated
///
/// So, to mitigate those issues, drop the outdated [`PreparedStatement`] manually
/// and prepare it again against the new schema.
Expand Down
4 changes: 2 additions & 2 deletions scylla/src/transport/session.rs
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ impl Session {
/// instead of calling `Session::connect` directly, because it's more convenient.
/// # Arguments
/// * `config` - Connection configuration - known nodes, Compression, etc.
/// Must contain at least one known node.
/// Must contain at least one known node.
///
/// # Example
/// ```rust
Expand Down Expand Up @@ -1335,7 +1335,7 @@ impl Session {
/// # Arguments
///
/// * `keyspace_name` - keyspace name to use,
/// keyspace names can have up to 48 alphanumeric characters and contain underscores
/// keyspace names can have up to 48 alphanumeric characters and contain underscores
/// * `case_sensitive` - if set to true the generated query will put keyspace name in quotes
/// # Example
/// ```rust
Expand Down

0 comments on commit 3c33c1d

Please sign in to comment.