Class SerializerHelperJson

Helper class for JSON serialization and deserialization.

public static class SerializerHelperJson

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

Reads an object instance from a JSON file.

Object type must have a parameterless constructor.

public static Task<T?> ReadFromJsonFile<T>(ILogger logger, string path, ReadFromJsonFileArgs args) where T : new()

Task<T>: Returns a new instance of the object read from the JSON file, or null if deserialization fails.

Writes the given object instance to a JSON file.

Object type must have a parameterless constructor.

Only public properties and variables will be written to the file. These can be any type though, even other classes.

If there are public properties/variables that you do not want written to the file, decorate them with the [JsonIgnore] attribute.

public static Task<bool> WriteToJsonFile<T>(ILogger logger, string path, T objectToWrite, WriteToJsonFileArgs? args = null) where T : new()

logger ILogger: The logger instance for error logging.
path string: The file path to write the object instance to.
objectToWrite T: The object instance to write to the file.
args WriteToJsonFileArgs: Optional arguments for controlling the write behavior.