Skip to content

Use std::result::Result instead of Result #4010

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

Merged
drganjoo merged 10 commits into from
Feb 20, 2025
Merged

Use std::result::Result instead of Result #4010

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
6b23112
Merge documentation of same inline modules
Feb 11, 2025
6850d73
Use rustTemplate for Result
Feb 12, 2025
b318141
Update changelog
aws-sdk-rust-ci Feb 12, 2025
38fcc45
Fuzz impl v2 (#3881)
rcoh Feb 13, 2025
a004acc
Fix mock_client macro (#4013)
rcoh Feb 13, 2025
a29b55a
Merge documentation of same inline modules (#4008)
drganjoo Feb 14, 2025
f4e533c
Use RuntimeType.preludeScope instead of defining local mapping
Feb 14, 2025
1bdb57d
Merge branch 'main' into fahadzub/fix-result
drganjoo Feb 14, 2025
83af2c8
Fix linting issue
Feb 18, 2025
8c3df73
Merge branch 'main' into fahadzub/fix-result
drganjoo Feb 19, 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
3 changes: 2 additions & 1 deletion ...rc/main/kotlin/software/amazon/smithy/rustsdk/customize/timestream/TimestreamDecorator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import software.amazon.smithy.rust.codegen.core.rustlang.Visibility
import software.amazon.smithy.rust.codegen.core.rustlang.rustTemplate
import software.amazon.smithy.rust.codegen.core.rustlang.toType
import software.amazon.smithy.rust.codegen.core.smithy.RuntimeType
import software.amazon.smithy.rust.codegen.core.smithy.RuntimeType.Companion.std
import software.amazon.smithy.rust.codegen.core.smithy.RustCrate
import software.amazon.smithy.rust.codegen.core.smithy.customize.AdHocCustomization
import software.amazon.smithy.rust.codegen.core.smithy.customize.adhocCustomization
Expand Down Expand Up @@ -60,7 +61,7 @@ class TimestreamDecorator : ClientCodegenDecorator {
// helper function to resolve an endpoint given a base client
rustTemplate(
"""
async fn resolve_endpoint(client: &crate::Client) -> Result<(#{Endpoint}, #{SystemTime}), #{BoxError}> {
async fn resolve_endpoint(client: &crate::Client) -> #{Result}<(#{Endpoint}, #{SystemTime}), #{BoxError}> {
let describe_endpoints =
client.describe_endpoints().send().await?;
let endpoint = describe_endpoints.endpoints().first().unwrap();
Expand Down
3 changes: 2 additions & 1 deletion ...amazon/smithy/rust/codegen/client/smithy/endpoint/generators/EndpointResolverGenerator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@ internal class EndpointResolverGenerator(
"EndpointError" to types.resolveEndpointError,
"ServiceSpecificEndpointResolver" to codegenContext.serviceSpecificEndpointResolver(),
"DiagnosticCollector" to EndpointsLib.DiagnosticCollector,
*preludeScope,
)

private val allowLintsForResolver =
Expand Down Expand Up @@ -195,7 +196,7 @@ internal class EndpointResolverGenerator(
Self { #{custom_fields_init:W} }
}

fn resolve_endpoint(&self, params: &#{Params}) -> Result<#{SmithyEndpoint}, #{BoxError}> {
fn resolve_endpoint(&self, params: &#{Params}) -> #{Result}<#{SmithyEndpoint}, #{BoxError}> {
let mut diagnostic_collector = #{DiagnosticCollector}::new();
Ok(#{resolver_fn}(params, &mut diagnostic_collector, #{additional_args})
.map_err(|err|err.with_source(diagnostic_collector.take_last_error()))?)
Expand Down
2 changes: 1 addition & 1 deletion ...tware/amazon/smithy/rust/codegen/client/smithy/generators/client/FluentClientGenerator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ class FluentClientGenerator(
&self.handle.conf
}

fn validate_config(handle: &Handle) -> Result<(), #{BoxError}> {
fn validate_config(handle: &Handle) -> #{Result}<(), #{BoxError}> {
let mut cfg = #{ConfigBag}::base();
handle.runtime_plugins
.apply_client_configuration(&mut cfg)?
Expand Down
8 changes: 5 additions & 3 deletions ...core/src/main/kotlin/software/amazon/smithy/rust/codegen/core/smithy/protocols/AwsJson.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ class AwsJsonSerializerGenerator(
arrayOf(
"Error" to runtimeConfig.serializationError(),
"SdkBody" to RuntimeType.sdkBody(runtimeConfig),
*RuntimeType.preludeScope,
)
private val protocolFunctions = ProtocolFunctions(codegenContext)

Expand All @@ -113,7 +114,7 @@ class AwsJsonSerializerGenerator(
serializer =
protocolFunctions.serializeFn(operationShape, fnNameSuffix = "input") { fnName ->
rustBlockTemplate(
"pub fn $fnName(_input: &#{target}) -> Result<#{SdkBody}, #{Error}>",
"pub fn $fnName(_input: &#{target}) -> #{Result}<#{SdkBody}, #{Error}>",
*codegenScope, "target" to codegenContext.symbolProvider.toSymbol(inputShape),
) {
rustTemplate("""Ok(#{SdkBody}::from("{}"))""", *codegenScope)
Expand All @@ -138,6 +139,7 @@ open class AwsJson(
CargoDependency.smithyJson(runtimeConfig).toType()
.resolve("deserialize::error::DeserializeError"),
"json_errors" to RuntimeType.jsonErrors(runtimeConfig),
*RuntimeType.preludeScope,
)

val version: AwsJsonVersion get() = awsJsonVersion
Expand All @@ -164,7 +166,7 @@ open class AwsJson(
ProtocolFunctions.crossOperationFn("parse_http_error_metadata") { fnName ->
rustTemplate(
"""
pub fn $fnName(_response_status: u16, response_headers: &#{Headers}, response_body: &[u8]) -> Result<#{ErrorMetadataBuilder}, #{JsonError}> {
pub fn $fnName(_response_status: u16, response_headers: &#{Headers}, response_body: &[u8]) -> #{Result}<#{ErrorMetadataBuilder}, #{JsonError}> {
#{json_errors}::parse_error_metadata(response_body, response_headers)
}
""",
Expand All @@ -177,7 +179,7 @@ open class AwsJson(
// `HeaderMap::new()` doesn't allocate.
rustTemplate(
"""
pub fn $fnName(payload: &#{Bytes}) -> Result<#{ErrorMetadataBuilder}, #{JsonError}> {
pub fn $fnName(payload: &#{Bytes}) -> #{Result}<#{ErrorMetadataBuilder}, #{JsonError}> {
#{json_errors}::parse_error_metadata(payload, &#{Headers}::new())
}
""",
Expand Down
5 changes: 3 additions & 2 deletions ...ore/src/main/kotlin/software/amazon/smithy/rust/codegen/core/smithy/protocols/AwsQuery.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ class AwsQueryProtocol(private val codegenContext: CodegenContext) : Protocol {
"ErrorMetadataBuilder" to RuntimeType.errorMetadataBuilder(runtimeConfig),
"Headers" to RuntimeType.headers(runtimeConfig),
"XmlDecodeError" to RuntimeType.smithyXml(runtimeConfig).resolve("decode::XmlDecodeError"),
*RuntimeType.preludeScope,
)

override val httpBindingResolver: HttpBindingResolver = AwsQueryBindingResolver(codegenContext.model)
Expand All @@ -61,7 +62,7 @@ class AwsQueryProtocol(private val codegenContext: CodegenContext) : Protocol {
override fun parseHttpErrorMetadata(operationShape: OperationShape): RuntimeType =
ProtocolFunctions.crossOperationFn("parse_http_error_metadata") { fnName ->
rustBlockTemplate(
"pub fn $fnName(_response_status: u16, _response_headers: &#{Headers}, response_body: &[u8]) -> Result<#{ErrorMetadataBuilder}, #{XmlDecodeError}>",
"pub fn $fnName(_response_status: u16, _response_headers: &#{Headers}, response_body: &[u8]) -> #{Result}<#{ErrorMetadataBuilder}, #{XmlDecodeError}>",
*errorScope,
) {
rust("#T::parse_error_metadata(response_body)", awsQueryErrors)
Expand All @@ -71,7 +72,7 @@ class AwsQueryProtocol(private val codegenContext: CodegenContext) : Protocol {
override fun parseEventStreamErrorMetadata(operationShape: OperationShape): RuntimeType =
ProtocolFunctions.crossOperationFn("parse_event_stream_error_metadata") { fnName ->
rustBlockTemplate(
"pub fn $fnName(payload: &#{Bytes}) -> Result<#{ErrorMetadataBuilder}, #{XmlDecodeError}>",
"pub fn $fnName(payload: &#{Bytes}) -> #{Result}<#{ErrorMetadataBuilder}, #{XmlDecodeError}>",
*errorScope,
) {
rust("#T::parse_error_metadata(payload.as_ref())", awsQueryErrors)
Expand Down
3 changes: 2 additions & 1 deletion ...in/kotlin/software/amazon/smithy/rust/codegen/core/smithy/protocols/AwsQueryCompatible.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ class AwsQueryCompatible(
.resolve("deserialize::error::DeserializeError"),
"aws_query_compatible_errors" to RuntimeType.awsQueryCompatibleErrors(runtimeConfig),
"json_errors" to RuntimeType.jsonErrors(runtimeConfig),
*RuntimeType.preludeScope,
)

override val httpBindingResolver: HttpBindingResolver =
Expand All @@ -77,7 +78,7 @@ class AwsQueryCompatible(
ProtocolFunctions.crossOperationFn("parse_http_error_metadata") { fnName ->
rustTemplate(
"""
pub fn $fnName(_response_status: u16, response_headers: &#{Headers}, response_body: &[u8]) -> Result<#{ErrorMetadataBuilder}, #{JsonError}> {
pub fn $fnName(_response_status: u16, response_headers: &#{Headers}, response_body: &[u8]) -> #{Result}<#{ErrorMetadataBuilder}, #{JsonError}> {
let mut builder =
#{json_errors}::parse_error_metadata(response_body, response_headers)?;
if let Some((error_code, error_type)) =
Expand Down
5 changes: 3 additions & 2 deletions ...ore/src/main/kotlin/software/amazon/smithy/rust/codegen/core/smithy/protocols/Ec2Query.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ class Ec2QueryProtocol(private val codegenContext: CodegenContext) : Protocol {
"ErrorMetadataBuilder" to RuntimeType.errorMetadataBuilder(runtimeConfig),
"Headers" to RuntimeType.headers(runtimeConfig),
"XmlDecodeError" to RuntimeType.smithyXml(runtimeConfig).resolve("decode::XmlDecodeError"),
*RuntimeType.preludeScope,
)

override val httpBindingResolver: HttpBindingResolver =
Expand All @@ -52,7 +53,7 @@ class Ec2QueryProtocol(private val codegenContext: CodegenContext) : Protocol {
override fun parseHttpErrorMetadata(operationShape: OperationShape): RuntimeType =
ProtocolFunctions.crossOperationFn("parse_http_error_metadata") { fnName ->
rustBlockTemplate(
"pub fn $fnName(_response_status: u16, _response_headers: &#{Headers}, response_body: &[u8]) -> Result<#{ErrorMetadataBuilder}, #{XmlDecodeError}>",
"pub fn $fnName(_response_status: u16, _response_headers: &#{Headers}, response_body: &[u8]) -> #{Result}<#{ErrorMetadataBuilder}, #{XmlDecodeError}>",
*errorScope,
) {
rust("#T::parse_error_metadata(response_body)", ec2QueryErrors)
Expand All @@ -62,7 +63,7 @@ class Ec2QueryProtocol(private val codegenContext: CodegenContext) : Protocol {
override fun parseEventStreamErrorMetadata(operationShape: OperationShape): RuntimeType =
ProtocolFunctions.crossOperationFn("parse_event_stream_error_metadata") {
rustBlockTemplate(
"pub fn parse_event_stream_error_metadata(payload: &#{Bytes}) -> Result<#{ErrorMetadataBuilder}, #{XmlDecodeError}>",
"pub fn parse_event_stream_error_metadata(payload: &#{Bytes}) -> #{Result}<#{ErrorMetadataBuilder}, #{XmlDecodeError}>",
*errorScope,
) {
rust("#T::parse_error_metadata(payload.as_ref())", ec2QueryErrors)
Expand Down
3 changes: 2 additions & 1 deletion ...are/amazon/smithy/rust/codegen/core/smithy/protocols/HttpBoundProtocolPayloadGenerator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ class HttpBoundProtocolPayloadGenerator(
"BuildError" to runtimeConfig.operationBuildError(),
"SmithyHttp" to RuntimeType.smithyHttp(runtimeConfig),
"NoOpSigner" to smithyEventStream.resolve("frame::NoOpSigner"),
*RuntimeType.preludeScope,
)
private val protocolFunctions = ProtocolFunctions(codegenContext)

Expand Down Expand Up @@ -300,7 +301,7 @@ class HttpBoundProtocolPayloadGenerator(
RuntimeType.ByteSlab.toSymbol()
}
rustBlockTemplate(
"pub fn $fnName(payload: $ref#{Member}) -> Result<#{outputT}, #{BuildError}>",
"pub fn $fnName(payload: $ref#{Member}) -> #{Result}<#{outputT}, #{BuildError}>",
"Member" to symbolProvider.toSymbol(member),
"outputT" to outputT,
*codegenScope,
Expand Down
5 changes: 3 additions & 2 deletions ...ore/src/main/kotlin/software/amazon/smithy/rust/codegen/core/smithy/protocols/RestJson.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ open class RestJson(val codegenContext: CodegenContext) : Protocol {
CargoDependency.smithyJson(runtimeConfig).toType()
.resolve("deserialize::error::DeserializeError"),
"json_errors" to RuntimeType.jsonErrors(runtimeConfig),
*RuntimeType.preludeScope,
)

override val httpBindingResolver: HttpBindingResolver =
Expand Down Expand Up @@ -120,7 +121,7 @@ open class RestJson(val codegenContext: CodegenContext) : Protocol {
ProtocolFunctions.crossOperationFn("parse_http_error_metadata") { fnName ->
rustTemplate(
"""
pub fn $fnName(_response_status: u16, response_headers: &#{Headers}, response_body: &[u8]) -> Result<#{ErrorMetadataBuilder}, #{JsonError}> {
pub fn $fnName(_response_status: u16, response_headers: &#{Headers}, response_body: &[u8]) -> #{Result}<#{ErrorMetadataBuilder}, #{JsonError}> {
#{json_errors}::parse_error_metadata(response_body, response_headers)
}
""",
Expand All @@ -133,7 +134,7 @@ open class RestJson(val codegenContext: CodegenContext) : Protocol {
// `HeaderMap::new()` doesn't allocate.
rustTemplate(
"""
pub fn $fnName(payload: &#{Bytes}) -> Result<#{ErrorMetadataBuilder}, #{JsonError}> {
pub fn $fnName(payload: &#{Bytes}) -> #{Result}<#{ErrorMetadataBuilder}, #{JsonError}> {
#{json_errors}::parse_error_metadata(payload, &#{Headers}::new())
}
""",
Expand Down
5 changes: 3 additions & 2 deletions ...core/src/main/kotlin/software/amazon/smithy/rust/codegen/core/smithy/protocols/RestXml.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ open class RestXml(val codegenContext: CodegenContext) : Protocol {
"ErrorMetadataBuilder" to RuntimeType.errorMetadataBuilder(runtimeConfig),
"Headers" to RuntimeType.headers(runtimeConfig),
"XmlDecodeError" to RuntimeType.smithyXml(runtimeConfig).resolve("decode::XmlDecodeError"),
*RuntimeType.preludeScope,
)

protected val restXmlErrors: RuntimeType =
Expand Down Expand Up @@ -58,7 +59,7 @@ open class RestXml(val codegenContext: CodegenContext) : Protocol {
override fun parseHttpErrorMetadata(operationShape: OperationShape): RuntimeType =
ProtocolFunctions.crossOperationFn("parse_http_error_metadata") { fnName ->
rustBlockTemplate(
"pub fn $fnName(_response_status: u16, _response_headers: &#{Headers}, response_body: &[u8]) -> Result<#{ErrorMetadataBuilder}, #{XmlDecodeError}>",
"pub fn $fnName(_response_status: u16, _response_headers: &#{Headers}, response_body: &[u8]) -> #{Result}<#{ErrorMetadataBuilder}, #{XmlDecodeError}>",
*errorScope,
) {
rust("#T::parse_error_metadata(response_body)", restXmlErrors)
Expand All @@ -68,7 +69,7 @@ open class RestXml(val codegenContext: CodegenContext) : Protocol {
override fun parseEventStreamErrorMetadata(operationShape: OperationShape): RuntimeType =
ProtocolFunctions.crossOperationFn("parse_event_stream_error_metadata") { fnName ->
rustBlockTemplate(
"pub fn $fnName(payload: &#{Bytes}) -> Result<#{ErrorMetadataBuilder}, #{XmlDecodeError}>",
"pub fn $fnName(payload: &#{Bytes}) -> #{Result}<#{ErrorMetadataBuilder}, #{XmlDecodeError}>",
*errorScope,
) {
rust("#T::parse_error_metadata(payload.as_ref())", restXmlErrors)
Expand Down
3 changes: 2 additions & 1 deletion ...re/src/main/kotlin/software/amazon/smithy/rust/codegen/core/smithy/protocols/RpcV2Cbor.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ open class RpcV2Cbor(
ProtocolFunctions.crossOperationFn("parse_event_stream_error_metadata") { fnName ->
rustTemplate(
"""
pub fn $fnName(payload: &#{Bytes}) -> Result<#{ErrorMetadataBuilder}, #{DeserializeError}> {
pub fn $fnName(payload: &#{Bytes}) -> #{Result}<#{ErrorMetadataBuilder}, #{DeserializeError}> {
#{cbor_errors}::parse_error_metadata(0, &#{Headers}::new(), payload)
}
""",
Expand All @@ -164,6 +164,7 @@ open class RpcV2Cbor(
CargoDependency.smithyCbor(runtimeConfig).toType()
.resolve("decode::DeserializeError"),
"Headers" to RuntimeType.headers(runtimeConfig),
*RuntimeType.preludeScope,
)
}

Expand Down
13 changes: 7 additions & 6 deletions ...in/software/amazon/smithy/rust/codegen/core/smithy/protocols/parse/JsonParserGenerator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ import software.amazon.smithy.rust.codegen.core.smithy.CodegenContext
import software.amazon.smithy.rust.codegen.core.smithy.CodegenTarget
import software.amazon.smithy.rust.codegen.core.smithy.RuntimeType
import software.amazon.smithy.rust.codegen.core.smithy.RuntimeType.Companion.preludeScope
import software.amazon.smithy.rust.codegen.core.smithy.RuntimeType.Companion.std
import software.amazon.smithy.rust.codegen.core.smithy.canUseDefault
import software.amazon.smithy.rust.codegen.core.smithy.customize.NamedCustomization
import software.amazon.smithy.rust.codegen.core.smithy.customize.Section
Expand Down Expand Up @@ -145,7 +146,7 @@ class JsonParserGenerator(
return protocolFunctions.deserializeFn(shape, fnNameSuffix) { fnName ->
val unusedMut = if (includedMembers.isEmpty()) "##[allow(unused_mut)] " else ""
rustBlockTemplate(
"pub(crate) fn $fnName(value: &[u8], ${unusedMut}mut builder: #{Builder}) -> Result<#{Builder}, #{Error}>",
"pub(crate) fn $fnName(value: &[u8], ${unusedMut}mut builder: #{Builder}) -> #{Result}<#{Builder}, #{Error}>",
"Builder" to builderSymbol,
*codegenScope,
) {
Expand All @@ -172,7 +173,7 @@ class JsonParserGenerator(
}
return protocolFunctions.deserializeFn(shape, fnNameSuffix = "payload") { fnName ->
rustBlockTemplate(
"pub(crate) fn $fnName(input: &[u8]) -> Result<#{ReturnType}, #{Error}>",
"pub(crate) fn $fnName(input: &[u8]) -> #{Result}<#{ReturnType}, #{Error}>",
*codegenScope,
"ReturnType" to returnSymbolToParse.symbol,
) {
Expand Down Expand Up @@ -396,7 +397,7 @@ class JsonParserGenerator(
protocolFunctions.deserializeFn(shape) { fnName ->
rustBlockTemplate(
"""
pub(crate) fn $fnName<'a, I>(tokens: &mut #{Peekable}<I>) -> Result<Option<#{ReturnType}>, #{Error}>
pub(crate) fn $fnName<'a, I>(tokens: &mut #{Peekable}<I>) -> #{Result}<Option<#{ReturnType}>, #{Error}>
where I: Iterator<Item = Result<#{Token}<'a>, #{Error}>>
""",
"ReturnType" to returnSymbol,
Expand Down Expand Up @@ -458,7 +459,7 @@ class JsonParserGenerator(
protocolFunctions.deserializeFn(shape) { fnName ->
rustBlockTemplate(
"""
pub(crate) fn $fnName<'a, I>(tokens: &mut #{Peekable}<I>) -> Result<Option<#{ReturnType}>, #{Error}>
pub(crate) fn $fnName<'a, I>(tokens: &mut #{Peekable}<I>) -> #{Result}<Option<#{ReturnType}>, #{Error}>
where I: Iterator<Item = Result<#{Token}<'a>, #{Error}>>
""",
"ReturnType" to returnSymbolToParse.symbol,
Expand Down Expand Up @@ -514,7 +515,7 @@ class JsonParserGenerator(
protocolFunctions.deserializeFn(shape) { fnName ->
rustBlockTemplate(
"""
pub(crate) fn $fnName<'a, I>(tokens: &mut #{Peekable}<I>) -> Result<Option<#{ReturnType}>, #{Error}>
pub(crate) fn $fnName<'a, I>(tokens: &mut #{Peekable}<I>) -> #{Result}<Option<#{ReturnType}>, #{Error}>
where I: Iterator<Item = Result<#{Token}<'a>, #{Error}>>
""",
"ReturnType" to returnSymbolToParse.symbol,
Expand Down Expand Up @@ -549,7 +550,7 @@ class JsonParserGenerator(
protocolFunctions.deserializeFn(shape) { fnName ->
rustBlockTemplate(
"""
pub(crate) fn $fnName<'a, I>(tokens: &mut #{Peekable}<I>) -> Result<Option<#{Shape}>, #{Error}>
pub(crate) fn $fnName<'a, I>(tokens: &mut #{Peekable}<I>) -> #{Result}<Option<#{Shape}>, #{Error}>
where I: Iterator<Item = Result<#{Token}<'a>, #{Error}>>
""",
*codegenScope,
Expand Down
Loading
Loading