Class Result

Inheritance
System.Object
Result
ValResult<T>
Namespace: Eco.Core.Utils
Assembly: Eco.Core.dll
Syntax
public class Result : Object

Constructors

Result()

Declaration
public Result()

Result(Result)

Declaration
protected Result(Result result)
Parameters
Type Name Description
Result result

Result(ResultType)

Declaration
public Result(ResultType type)
Parameters
Type Name Description
ResultType type

Result(LocString, Boolean)

Declaration
public Result(LocString message, bool success = false)
Parameters
Type Name Description
LocString message
System.Boolean success

Result(String, Boolean)

Declaration
public Result(string message, bool success = false)
Parameters
Type Name Description
System.String message
System.Boolean success

Fields

Debug

Declaration
public string Debug
Field Value
Type Description
System.String

Value

Declaration
public ResultType Value
Field Value
Type Description
ResultType

Properties

Failed

Declaration
public bool Failed { get; }
Property Value
Type Description
System.Boolean

FailedNoMessage

Declaration
public static Result FailedNoMessage { get; }
Property Value
Type Description
Result

Message

Declaration
public LocString Message { get; set; }
Property Value
Type Description
LocString

NotificationCategory

Declaration
public Nullable<NotificationCategory> NotificationCategory { get; set; }
Property Value
Type Description
System.Nullable<NotificationCategory>

NotificationStyle

Declaration
public Nullable<NotificationStyle> NotificationStyle { get; set; }
Property Value
Type Description
System.Nullable<NotificationStyle>

Succeeded

Declaration
public static Result Succeeded { get; }
Property Value
Type Description
Result

Success

Declaration
public bool Success { get; set; }
Property Value
Type Description
System.Boolean

ToStringStripped

Declaration
public string ToStringStripped { get; }
Property Value
Type Description
System.String

Methods

AnnotateIfFailed(Boolean, String, String)

Declaration
public static Result AnnotateIfFailed(bool result, string parameterName, string objectName)
Parameters
Type Name Description
System.Boolean result
System.String parameterName
System.String objectName
Returns
Type Description
Result

AppendDebug(String)

Declaration
public void AppendDebug(string debugText)
Parameters
Type Name Description
System.String debugText

AppendDebugLoc(FormattableString)

Declaration
public void AppendDebugLoc(FormattableString debugText)
Parameters
Type Name Description
System.FormattableString debugText

AppendLine(LocString)

Declaration
public void AppendLine(LocString other)
Parameters
Type Name Description
LocString other

AppendLine(FormattableString)

Declaration
public void AppendLine(FormattableString other)
Parameters
Type Name Description
System.FormattableString other

Fail(LocString)

Declaration
public static Result Fail(LocString s)
Parameters
Type Name Description
LocString s
Returns
Type Description
Result

FailLoc(FormattableString)

Declaration
public static Result FailLoc(FormattableString s)
Parameters
Type Name Description
System.FormattableString s
Returns
Type Description
Result

FailLocStr(String)

Declaration
public static Result FailLocStr(string s)
Parameters
Type Name Description
System.String s
Returns
Type Description
Result

FailNT(FormattableString)

Declaration
public static Result FailNT(FormattableString s)
Parameters
Type Name Description
System.FormattableString s
Returns
Type Description
Result

FailNTStr(String)

Declaration
public static Result FailNTStr(string s)
Parameters
Type Name Description
System.String s
Returns
Type Description
Result

FixCaps()

Declaration
public Result FixCaps()
Returns
Type Description
Result

IsFailed(out LocString)

Check if result failed and saves fail message into output parameter.

Declaration
public bool IsFailed(out LocString message)
Parameters
Type Name Description
LocString message
Returns
Type Description
System.Boolean

Localize(FormattableString, Boolean)

Declaration
public static Result Localize(FormattableString s, bool success = false)
Parameters
Type Name Description
System.FormattableString s
System.Boolean success
Returns
Type Description
Result

LocalizeStr(String, Boolean)

Declaration
public static Result LocalizeStr(string s, bool success = false)
Parameters
Type Name Description
System.String s
System.Boolean success
Returns
Type Description
Result

Merge(Result)

Declaration
public virtual Result Merge(Result other)
Parameters
Type Name Description
Result other
Returns
Type Description
Result

Merge(IEnumerable<Result>)

Declaration
public static Result Merge(IEnumerable<Result> others)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<Result> others
Returns
Type Description
Result

MergeFail(String)

Declaration
public Result MergeFail(string other)
Parameters
Type Name Description
System.String other
Returns
Type Description
Result

MergeFailLoc(FormattableString)

Declaration
public Result MergeFailLoc(FormattableString other)
Parameters
Type Name Description
System.FormattableString other
Returns
Type Description
Result

None(String)

Declaration
public static Result None(string debugText)
Parameters
Type Name Description
System.String debugText
Returns
Type Description
Result

Prepend(LocString, String)

Declaration
public Result Prepend(LocString other, string spacer = " ")
Parameters
Type Name Description
LocString other
System.String spacer
Returns
Type Description
Result

Prepend(FormattableString, String)

Declaration
public Result Prepend(FormattableString other, string spacer = " ")
Parameters
Type Name Description
System.FormattableString other
System.String spacer
Returns
Type Description
Result

PrependNT(String, String)

Declaration
public Result PrependNT(string other, string spacer = " ")
Parameters
Type Name Description
System.String other
System.String spacer
Returns
Type Description
Result

RunAll(Func<Result>[])

Declaration
public static Result RunAll(params Func<Result>[] p)
Parameters
Type Name Description
System.Func<Result>[] p
Returns
Type Description
Result

SetIfFailedLoc(FormattableString, Boolean)

Declaration
public static Result SetIfFailedLoc(FormattableString failMessage, bool success)
Parameters
Type Name Description
System.FormattableString failMessage
System.Boolean success
Returns
Type Description
Result

SetSucceed(Boolean, LocString)

Declaration
public static Result SetSucceed(bool success, LocString s = null)
Parameters
Type Name Description
System.Boolean success
LocString s
Returns
Type Description
Result

Succeed(LocString)

Declaration
public static Result Succeed(LocString s)
Parameters
Type Name Description
LocString s
Returns
Type Description
Result

SucceedLoc(FormattableString)

Declaration
public static Result SucceedLoc(FormattableString s)
Parameters
Type Name Description
System.FormattableString s
Returns
Type Description
Result

SucceedNT(FormattableString)

Declaration
public static Result SucceedNT(FormattableString s)
Parameters
Type Name Description
System.FormattableString s
Returns
Type Description
Result

SucceedNTStr(String)

Declaration
public static Result SucceedNTStr(string s)
Parameters
Type Name Description
System.String s
Returns
Type Description
Result

TapToIfNotSet(ref Result)

Taps this to another result if result has no value and returns this. Useful in workflow where you want to check multiple results sequentially and remember first result.

Declaration
public Result TapToIfNotSet(ref Result result)
Parameters
Type Name Description
Result result
Returns
Type Description
Result

Test(Func<Result>)

Declaration
public Result Test(Func<Result> p)
Parameters
Type Name Description
System.Func<Result> p
Returns
Type Description
Result

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String

Operators

Implicit(Result to Boolean)

Declaration
public static implicit operator bool (Result result)
Parameters
Type Name Description
Result result
Returns
Type Description
System.Boolean

Extension Methods