Unverified Commit a2ccdf70 authored by John DiSanti's avatar John DiSanti Committed by GitHub
Browse files

Add `#[doc(hidden)]` to struct fields to encourage accessor use (#1573)

parent ed2a866c

CHANGELOG.next.toml

+12 −0
Original line number Diff line number Diff line
@@ -225,3 +225,15 @@ message = "Support @deprecated trait for aggregate shapes" 
references = ["smithy-rs#1570"]

meta = { "breaking" = true, "tada" = true, "bug" = false }

author = "weihanglo"



[[smithy-rs]]

message = "Non-streaming struct members are now marked `#[doc(hidden)]` since they will be removed in the future"

references = ["smithy-rs#1573", "smithy-rs#1569"]

meta = { "breaking" = false, "tada" = false, "bug" = false }

author = "jdisanti"



[[aws-sdk-rust]]

message = "Non-streaming struct members are now marked `#[doc(hidden)]` since they will be removed in the future"

references = ["smithy-rs#1573", "smithy-rs#1569"]

meta = { "breaking" = false, "tada" = false, "bug" = false }

author = "jdisanti"

codegen-server/python/src/main/kotlin/software/amazon/smithy/rust/codegen/server/python/smithy/PythonCodegenServerPlugin.kt

+1 −1
Original line number Diff line number Diff line
@@ -79,7 +79,7 @@ class PythonCodegenServerPlugin : SmithyBuildPlugin { 
                // `aws_smithy_http_server_python::types`.

                .let { PythonServerSymbolProvider(it, model) }

                // Add Rust attributes (like `#[derive(PartialEq)]`) to generated shapes

                .let { BaseSymbolMetadataProvider(it, additionalAttributes = listOf()) }

                .let { BaseSymbolMetadataProvider(it, model, additionalAttributes = listOf()) }

                // Streaming shapes need different derives (e.g. they cannot derive Eq)

                .let { StreamingShapeMetadataProvider(it, model) }

                // Rename shapes that clash with Rust reserved words & and other SDK specific features e.g. `send()` cannot

codegen-server/src/main/kotlin/software/amazon/smithy/rust/codegen/server/smithy/RustCodegenServerPlugin.kt

+1 −1
Original line number Diff line number Diff line
@@ -70,7 +70,7 @@ class RustCodegenServerPlugin : SmithyBuildPlugin { 
                // Generate [ByteStream] instead of `Blob` for streaming binary shapes (e.g. S3 GetObject)

                .let { StreamingShapeSymbolProvider(it, model) }

                // Add Rust attributes (like `#[derive(PartialEq)]`) to generated shapes

                .let { BaseSymbolMetadataProvider(it, additionalAttributes = listOf()) }

                .let { BaseSymbolMetadataProvider(it, model, additionalAttributes = listOf()) }

                // Streaming shapes need different derives (e.g. they cannot derive Eq)

                .let { StreamingShapeMetadataProvider(it, model) }

                // Rename shapes that clash with Rust reserved words & and other SDK specific features e.g. `send()` cannot

codegen/src/main/kotlin/software/amazon/smithy/rust/codegen/rustlang/RustTypes.kt

+1 −0
Original line number Diff line number Diff line
@@ -333,6 +333,7 @@ sealed class Attribute { 
         */

        val NonExhaustive = Custom("non_exhaustive")

        val AllowUnusedMut = Custom("allow(unused_mut)")

        val DocHidden = Custom("doc(hidden)")

        val DocInline = Custom("doc(inline)")

    }

codegen/src/main/kotlin/software/amazon/smithy/rust/codegen/smithy/RustCodegenPlugin.kt

+1 −1
Original line number Diff line number Diff line
@@ -66,7 +66,7 @@ class RustCodegenPlugin : SmithyBuildPlugin { 
                // Generate `ByteStream` instead of `Blob` for streaming binary shapes (e.g. S3 GetObject)

                .let { StreamingShapeSymbolProvider(it, model) }

                // Add Rust attributes (like `#[derive(PartialEq)]`) to generated shapes

                .let { BaseSymbolMetadataProvider(it, additionalAttributes = listOf(NonExhaustive)) }

                .let { BaseSymbolMetadataProvider(it, model, additionalAttributes = listOf(NonExhaustive)) }

                // Streaming shapes need different derives (e.g. they cannot derive Eq)

                .let { StreamingShapeMetadataProvider(it, model) }

                // Rename shapes that clash with Rust reserved words & and other SDK specific features e.g. `send()` cannot