From 806173beab4c5269bd61fbadf49a1d4761d94b70 Mon Sep 17 00:00:00 2001 From: Ethan Celletti Date: Mon, 6 Feb 2023 08:23:17 -0800 Subject: [PATCH] Removing bad ToOptionalObject helper --- src/Candid/API.md | 30 --------------------------- src/Candid/API.xml | 9 -------- src/Candid/Models/CandidTypedValue.cs | 20 ++---------------- 3 files changed, 2 insertions(+), 57 deletions(-) diff --git a/src/Candid/API.md b/src/Candid/API.md index 97daaa85..232d612f 100644 --- a/src/Candid/API.md +++ b/src/Candid/API.md @@ -300,7 +300,6 @@ - [Reserved()](#M-EdjCase-ICP-Candid-Models-CandidTypedValue-Reserved 'EdjCase.ICP.Candid.Models.CandidTypedValue.Reserved') - [Text(value)](#M-EdjCase-ICP-Candid-Models-CandidTypedValue-Text-System-String- 'EdjCase.ICP.Candid.Models.CandidTypedValue.Text(System.String)') - [ToObject\`\`1(converter)](#M-EdjCase-ICP-Candid-Models-CandidTypedValue-ToObject``1-EdjCase-ICP-Candid-CandidConverter- 'EdjCase.ICP.Candid.Models.CandidTypedValue.ToObject``1(EdjCase.ICP.Candid.CandidConverter)') - - [ToOptionalObject\`\`1(converter)](#M-EdjCase-ICP-Candid-Models-CandidTypedValue-ToOptionalObject``1-EdjCase-ICP-Candid-CandidConverter- 'EdjCase.ICP.Candid.Models.CandidTypedValue.ToOptionalObject``1(EdjCase.ICP.Candid.CandidConverter)') - [Vector(innerType,values)](#M-EdjCase-ICP-Candid-Models-CandidTypedValue-Vector-EdjCase-ICP-Candid-Models-Types-CandidType,EdjCase-ICP-Candid-Models-Values-CandidValue[]- 'EdjCase.ICP.Candid.Models.CandidTypedValue.Vector(EdjCase.ICP.Candid.Models.Types.CandidType,EdjCase.ICP.Candid.Models.Values.CandidValue[])') - [Vector\`\`1(innerType,values,valueConverter)](#M-EdjCase-ICP-Candid-Models-CandidTypedValue-Vector``1-EdjCase-ICP-Candid-Models-Types-CandidType,System-Collections-Generic-IEnumerable{``0},System-Func{``0,EdjCase-ICP-Candid-Models-Values-CandidValue}- 'EdjCase.ICP.Candid.Models.CandidTypedValue.Vector``1(EdjCase.ICP.Candid.Models.Types.CandidType,System.Collections.Generic.IEnumerable{``0},System.Func{``0,EdjCase.ICP.Candid.Models.Values.CandidValue})') - [op_Equality()](#M-EdjCase-ICP-Candid-Models-CandidTypedValue-op_Equality-EdjCase-ICP-Candid-Models-CandidTypedValue,EdjCase-ICP-Candid-Models-CandidTypedValue- 'EdjCase.ICP.Candid.Models.CandidTypedValue.op_Equality(EdjCase.ICP.Candid.Models.CandidTypedValue,EdjCase.ICP.Candid.Models.CandidTypedValue)') @@ -4137,35 +4136,6 @@ Value of type T | ---- | ----------- | | T | Type to convert the candid value to | - -### ToOptionalObject\`\`1(converter) `method` - -##### Summary - -Helper method to convert a typed value to an optional value. The typed value must be an opt - -##### Returns - -Optional value of T - -##### Parameters - -| Name | Type | Description | -| ---- | ---- | ----------- | -| converter | [EdjCase.ICP.Candid.CandidConverter](#T-EdjCase-ICP-Candid-CandidConverter 'EdjCase.ICP.Candid.CandidConverter') | Optional. Converter to use for the conversion, otherwise will use default converter | - -##### Generic Types - -| Name | Description | -| ---- | ----------- | -| T | Type to convert the candid value to | - -##### Exceptions - -| Name | Description | -| ---- | ----------- | -| [System.InvalidOperationException](http://msdn.microsoft.com/query/dev14.query?appId=Dev14IDEF1&l=EN-US&k=k:System.InvalidOperationException 'System.InvalidOperationException') | Throws if the value is not an opt | - ### Vector(innerType,values) `method` diff --git a/src/Candid/API.xml b/src/Candid/API.xml index 2eacadfa..1bffe33e 100644 --- a/src/Candid/API.xml +++ b/src/Candid/API.xml @@ -675,15 +675,6 @@ The candid value. Must match the specified type The candid type. Must match the specified value - - - Helper method to convert a typed value to an optional value. The typed value must be an opt - - Type to convert the candid value to - Optional. Converter to use for the conversion, otherwise will use default converter - Optional value of T - Throws if the value is not an opt - Helper method to convert a typed value to an generic type value diff --git a/src/Candid/Models/CandidTypedValue.cs b/src/Candid/Models/CandidTypedValue.cs index 6218f14c..6c79b8e7 100644 --- a/src/Candid/Models/CandidTypedValue.cs +++ b/src/Candid/Models/CandidTypedValue.cs @@ -30,23 +30,7 @@ public CandidTypedValue(CandidValue value, CandidType type) this.Value = value ?? throw new ArgumentNullException(nameof(value)); this.Type = type ?? throw new ArgumentNullException(nameof(type)); } - - /// - /// Helper method to convert a typed value to an optional value. The typed value must be an opt - /// - /// Type to convert the candid value to - /// Optional. Converter to use for the conversion, otherwise will use default converter - /// Optional value of T - /// Throws if the value is not an opt - public OptionalValue ToOptionalObject(CandidConverter? converter = null) - { - if (this.Value is CandidOptional o) - { - return (converter ?? CandidConverter.Default).ToOptionalObject(o); - } - throw new InvalidOperationException("Value must be an optional type"); - } - + /// /// Helper method to convert a typed value to an generic type value /// @@ -55,7 +39,7 @@ public OptionalValue ToOptionalObject(CandidConverter? converter = null) /// Value of type T public T ToObject(CandidConverter? converter = null) { - return this.ToOptionalObject(converter).GetValueOrThrow(); + return (converter ?? CandidConverter.Default).ToObject(this.Value); } ///