Skip to content

Commit 5c7c12b

Browse files
committed
Adjust macros docs to new paths
Documentation was moved from scylla-cql to scylla, which made some paths used in those docs incorrect. This commit updates paths to correct ones.
1 parent 64470f7 commit 5c7c12b

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

scylla/src/macros.rs

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ pub use scylla_cql::macros::FromUserType;
1010
/// Works only on simple structs without generics etc
1111
pub use scylla_cql::macros::IntoUserType;
1212

13-
/// Derive macro for the [`SerializeCql`](crate::types::serialize::value::SerializeCql) trait
13+
/// Derive macro for the [`SerializeCql`](crate::serialize::value::SerializeCql) trait
1414
/// which serializes given Rust structure as a User Defined Type (UDT).
1515
///
1616
/// At the moment, only structs with named fields are supported.
@@ -28,8 +28,8 @@ pub use scylla_cql::macros::IntoUserType;
2828
/// This behavior is the default to support ALTERing UDTs by adding new fields.
2929
/// You can require exact match of fields using `force_exact_match` attribute.
3030
///
31-
/// In case of failure, either [`BuiltinTypeCheckError`](crate::types::serialize::value::BuiltinTypeCheckError)
32-
/// or [`BuiltinSerializationError`](crate::types::serialize::value::BuiltinSerializationError)
31+
/// In case of failure, either [`BuiltinTypeCheckError`](crate::serialize::value::BuiltinTypeCheckError)
32+
/// or [`BuiltinSerializationError`](crate::serialize::value::BuiltinSerializationError)
3333
/// will be returned.
3434
///
3535
/// # Example
@@ -43,9 +43,8 @@ pub use scylla_cql::macros::IntoUserType;
4343
/// ...can be serialized using the following struct:
4444
///
4545
/// ```rust
46-
/// # use scylla_cql::macros::SerializeCql;
46+
/// # use scylla::SerializeCql;
4747
/// #[derive(SerializeCql)]
48-
/// # #[scylla(crate = scylla_cql)]
4948
/// struct MyUdt {
5049
/// a: i32,
5150
/// b: Option<String>,
@@ -74,7 +73,7 @@ pub use scylla_cql::macros::IntoUserType;
7473
///
7574
/// By default, the code generated by the derive macro will refer to the items
7675
/// defined by the driver (types, traits, etc.) via the `::scylla` path.
77-
/// For example, it will refer to the [`SerializeCql`](crate::types::serialize::value::SerializeCql) trait
76+
/// For example, it will refer to the [`SerializeCql`](crate::serialize::value::SerializeCql) trait
7877
/// using the following path:
7978
///
8079
/// ```rust,ignore
@@ -120,16 +119,16 @@ pub use scylla_cql::macros::IntoUserType;
120119
/// Don't use the field during serialization.
121120
pub use scylla_cql::macros::SerializeCql;
122121

123-
/// Derive macro for the [`SerializeRow`](crate::types::serialize::row::SerializeRow) trait
122+
/// Derive macro for the [`SerializeRow`](crate::serialize::row::SerializeRow) trait
124123
/// which serializes given Rust structure into bind markers for a CQL statement.
125124
///
126125
/// At the moment, only structs with named fields are supported.
127126
///
128127
/// Serialization will fail if there are some bind markers/columns in the statement
129128
/// that don't match to any of the Rust struct fields, _or vice versa_.
130129
///
131-
/// In case of failure, either [`BuiltinTypeCheckError`](crate::types::serialize::row::BuiltinTypeCheckError)
132-
/// or [`BuiltinSerializationError`](crate::types::serialize::row::BuiltinSerializationError)
130+
/// In case of failure, either [`BuiltinTypeCheckError`](crate::serialize::row::BuiltinTypeCheckError)
131+
/// or [`BuiltinSerializationError`](crate::serialize::row::BuiltinSerializationError)
133132
/// will be returned.
134133
///
135134
/// # Example
@@ -145,9 +144,8 @@ pub use scylla_cql::macros::SerializeCql;
145144
/// ...the values for the query can be serialized using the following struct:
146145
///
147146
/// ```rust
148-
/// # use scylla_cql::macros::SerializeRow;
147+
/// # use scylla::SerializeRow;
149148
/// #[derive(SerializeRow)]
150-
/// # #[scylla(crate = scylla_cql)]
151149
/// struct MyValues {
152150
/// a: i32,
153151
/// b: Option<String>,
@@ -176,7 +174,7 @@ pub use scylla_cql::macros::SerializeCql;
176174
///
177175
/// By default, the code generated by the derive macro will refer to the items
178176
/// defined by the driver (types, traits, etc.) via the `::scylla` path.
179-
/// For example, it will refer to the [`SerializeRow`](crate::types::serialize::row::SerializeRow) trait
177+
/// For example, it will refer to the [`SerializeRow`](crate::serialize::row::SerializeRow) trait
180178
/// using the following path:
181179
///
182180
/// ```rust,ignore

0 commit comments

Comments
 (0)