diff --git a/.api-surface/FEx/Agnostics.Abstractions.toml b/.api-surface/FEx/Agnostics.Abstractions.toml index 8e83e85c..7b66ccab 100644 --- a/.api-surface/FEx/Agnostics.Abstractions.toml +++ b/.api-surface/FEx/Agnostics.Abstractions.toml @@ -8,41 +8,409 @@ ns = "FEx.Agnostics.Abstractions" file = "AsyncStatics.cs" static = true +[[properties]] +parent = "AsyncStatics" +name = "DefaultDelay" +sig = "static TimeSpan DefaultDelay { get; set; }" +returns = "TimeSpan" +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "ExecuteOnThreadPoolAsync" +sig = "static Task ExecuteOnThreadPoolAsync(Action action)" +returns = "Task" +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "ExecuteOnThreadPoolAsync" +sig = "static Task ExecuteOnThreadPoolAsync(Action action, AsyncOptions options)" +returns = "Task" +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "ExecuteOnThreadPoolAsync" +sig = "static Task ExecuteOnThreadPoolAsync(Action action, AsyncOptions options, CancellationToken cancellationToken)" +returns = "Task" +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "ExecuteOnThreadPoolAsync" +sig = "static Task ExecuteOnThreadPoolAsync(Func func)" +returns = "Task" +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "ExecuteOnThreadPoolAsync" +sig = "static Task ExecuteOnThreadPoolAsync(Func func, AsyncOptions options)" +returns = "Task" +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "ExecuteOnThreadPoolAsync" +sig = "static Task ExecuteOnThreadPoolAsync(Func func, AsyncOptions options, CancellationToken cancellationToken)" +returns = "Task" +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "ExecuteTaskOnThreadPoolAsync" +sig = "static Task ExecuteTaskOnThreadPoolAsync(Func func)" +returns = "Task" +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "ExecuteTaskOnThreadPoolAsync" +sig = "static Task ExecuteTaskOnThreadPoolAsync(Func func, AsyncOptions options)" +returns = "Task" +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "ExecuteTaskOnThreadPoolAsync" +sig = "static Task ExecuteTaskOnThreadPoolAsync(Func> func)" +returns = "Task" +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "ExecuteTaskOnThreadPoolAsync" +sig = "static Task ExecuteTaskOnThreadPoolAsync(Func> func, AsyncOptions options)" +returns = "Task" +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "DelayAsync" +sig = "static Task DelayAsync(int millisecondsDelay)" +returns = "Task" +summary = "Creates a cancellable task that completes after a time delay." +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "DelayAsync" +sig = "static Task DelayAsync(int millisecondsDelay, CancellationToken cancellationToken)" +returns = "Task" +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "DelayAsync" +sig = "static Task DelayAsync(TimeSpan delay)" +returns = "Task" +summary = "Creates a cancellable task that completes after a specified time interval." +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "DelayAsync" +sig = "static Task DelayAsync(TimeSpan delay, CancellationToken cancellationToken)" +returns = "Task" +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "DelayUntilAsync" +sig = "static Task DelayUntilAsync(Func predicate, Action action = null, double milliseconds = 0, CancellationToken cancellationToken = default)" +returns = "Task" +summary = "Waits asynchronously the specified amount of milliseconds." +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "DelayUntilAsync" +sig = "static Task DelayUntilAsync(Func> predicate, Action action = null, double milliseconds = 0, CancellationToken cancellationToken = default)" +returns = "Task" +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "DelayWithTimespanUntilAsync" +sig = "static Task DelayWithTimespanUntilAsync(Func predicate, Action action = null, TimeSpan? timeSpan = null, CancellationToken cancellationToken = default)" +returns = "Task" +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "DelayWithTimespanUntilAsync" +sig = "static Task DelayWithTimespanUntilAsync(Func> predicate, Action action = null, TimeSpan? timeSpan = null, CancellationToken cancellationToken = default)" +returns = "Task" +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "WaitAndInvokeActionAsync" +sig = "static Task WaitAndInvokeActionAsync(double delayMilliseconds = 0, Action action = null, CancellationToken cancellationToken = default)" +returns = "Task" +summary = "Waits asynchronously the specified amount of milliseconds and invokes action." +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "WaitAndInvokeActionAsync" +sig = "static Task WaitAndInvokeActionAsync(TimeSpan? delayTimeSpan = null, Action action = null, CancellationToken cancellationToken = default)" +returns = "Task" +file = "AsyncStatics.cs" +static = true + +[[methods]] +parent = "AsyncStatics" +name = "RunAsThread" +sig = "static void RunAsThread(Action action, ApartmentState? state = null, bool? isBackground = false)" +returns = "void" +file = "AsyncStatics.cs" +static = true + [[classes]] name = "FExAgnosticsStatics" ns = "FEx.Agnostics.Abstractions" summary = "Provides static access to core FEx services at the agnostics layer. This class MUST be initialized by higher-level layers (e.g., FEx.Core) before use." file = "FExAgnosticsStatics.cs" +[[properties]] +parent = "FExAgnosticsStatics" +name = "AsyncHelper" +sig = "static IAsyncHelper AsyncHelper { get; }" +returns = "IAsyncHelper" +summary = "Gets the instance. ⚠️ This property must be initialized by calling before first use. ⚠️ Typically initialized automatically by FEx.Core during application startup." +file = "FExAgnosticsStatics.cs" +static = true + +[[methods]] +parent = "FExAgnosticsStatics" +name = "Configure" +sig = "static void Configure(IAsyncHelper asyncHelper)" +returns = "void" +summary = "Configures the static services. This should be called during application initialization." +file = "FExAgnosticsStatics.cs" +static = true + +[[methods]] +parent = "FExAgnosticsStatics" +name = "Reset" +sig = "static void Reset()" +returns = "void" +summary = "Resets the configuration. Used primarily for testing." +file = "FExAgnosticsStatics.cs" +static = true + [[classes]] name = "FExInitializable" ns = "FEx.Agnostics.Abstractions" base = "IFExInitializable" file = "FExInitializable.cs" +[[properties]] +parent = "FExInitializable" +name = "IsInitialized" +sig = "bool IsInitialized { get; }" +returns = "bool" +file = "FExInitializable.cs" + +[[ctors]] +parent = "FExInitializable" +sig = "FExInitializable(params IFExInitializable[] dependencies)" +file = "FExInitializable.cs" + +[[methods]] +parent = "FExInitializable" +name = "Initialize" +sig = "void Initialize()" +returns = "void" +file = "FExInitializable.cs" + +[[methods]] +parent = "FExInitializable" +name = "OnInitialize" +sig = "void OnInitialize()" +returns = "void" +file = "FExInitializable.cs" + [[classes]] name = "Index" ns = "FEx.Agnostics.Abstractions.Collections" base = "IIndex" file = "Collections\\Index.cs" +[[properties]] +parent = "Index" +name = "Count" +sig = "int Count { get; }" +returns = "int" +file = "Collections\\Index.cs" + +[[properties]] +parent = "Index" +name = "IsReadOnly" +sig = "bool IsReadOnly { get; }" +returns = "bool" +file = "Collections\\Index.cs" + +[[ctors]] +parent = "Index" +sig = "Index(IDictionary dictionary)" +file = "Collections\\Index.cs" + +[[methods]] +parent = "Index" +name = "Add" +sig = "void Add(KeyValuePair item)" +returns = "void" +file = "Collections\\Index.cs" + +[[methods]] +parent = "Index" +name = "Clear" +sig = "void Clear()" +returns = "void" +file = "Collections\\Index.cs" + +[[methods]] +parent = "Index" +name = "Contains" +sig = "bool Contains(KeyValuePair item)" +returns = "bool" +file = "Collections\\Index.cs" + +[[methods]] +parent = "Index" +name = "CopyTo" +sig = "void CopyTo(KeyValuePair[] array, int arrayIndex)" +returns = "void" +file = "Collections\\Index.cs" + +[[methods]] +parent = "Index" +name = "Remove" +sig = "bool Remove(KeyValuePair item)" +returns = "bool" +file = "Collections\\Index.cs" + +[[methods]] +parent = "Index" +name = "Add" +sig = "void Add(TKey key, TValue value)" +returns = "void" +file = "Collections\\Index.cs" + +[[methods]] +parent = "Index" +name = "ContainsKey" +sig = "bool ContainsKey(TKey key)" +returns = "bool" +file = "Collections\\Index.cs" + +[[methods]] +parent = "Index" +name = "Remove" +sig = "bool Remove(TKey key)" +returns = "bool" +file = "Collections\\Index.cs" + +[[methods]] +parent = "Index" +name = "TryGetValue" +sig = "bool TryGetValue(TKey key, out TValue value)" +returns = "bool" +file = "Collections\\Index.cs" + +[[methods]] +parent = "Index" +name = "GetEnumerator" +sig = "IEnumerator> GetEnumerator()" +returns = "IEnumerator>" +file = "Collections\\Index.cs" + [[classes]] name = "Map" ns = "FEx.Agnostics.Abstractions.Collections" base = "IMap" file = "Collections\\Map.cs" -[[classes]] -name = "BaseConcurrentList" -ns = "FEx.Agnostics.Abstractions.Collections.Concurrent" -base = "ISuppressEvents" -file = "Collections\\Concurrent\\BaseConcurrentList.cs" +[[properties]] +parent = "Map" +name = "ForwardIndex" +sig = "IIndex ForwardIndex { get; }" +returns = "IIndex" +file = "Collections\\Map.cs" + +[[properties]] +parent = "Map" +name = "ReverseIndex" +sig = "IIndex ReverseIndex { get; }" +returns = "IIndex" +file = "Collections\\Map.cs" + +[[ctors]] +parent = "Map" +sig = "Map()" +file = "Collections\\Map.cs" + +[[ctors]] +parent = "Map" +sig = "Map(IDictionary dictionary, bool isReadOnly = false)" +file = "Collections\\Map.cs" + +[[methods]] +parent = "Map" +name = "Add" +sig = "void Add(TForwardKey t1, TReverseKey t2)" +returns = "void" +file = "Collections\\Map.cs" + +[[methods]] +parent = "Map" +name = "Clear" +sig = "void Clear()" +returns = "void" +file = "Collections\\Map.cs" + +[[methods]] +parent = "Map" +name = "SetReadOnly" +sig = "void SetReadOnly()" +returns = "void" +file = "Collections\\Map.cs" [[classes]] name = "CollectionEventsConfig" ns = "FEx.Agnostics.Abstractions.Configuration" file = "Configuration\\CollectionEventsConfig.cs" +[[properties]] +parent = "CollectionEventsConfig" +name = "PassIndexOfRemovedItem" +sig = "bool PassIndexOfRemovedItem { get; set; }" +returns = "bool" +file = "Configuration\\CollectionEventsConfig.cs" + [[enums]] name = "AsyncMode" ns = "FEx.Agnostics.Abstractions.Enums" @@ -82,8 +450,8 @@ static = true [[extensions]] name = "HasFlagFast" -sig = "bool HasFlagFast(this AsyncOptions value, AsyncOptions flag)" returns = "bool" +sig = "bool HasFlagFast(this AsyncOptions value, AsyncOptions flag)" file = "Extensions\\AsyncOptionsExtensions.cs" [[classes]] @@ -94,85 +462,106 @@ static = true [[extensions]] name = "AndNot" -sig = "bool AndNot(this bool first, bool second)" returns = "bool" +sig = "bool AndNot(this bool first, bool second)" summary = "Combines 2 boolean (And Not operation)." file = "Extensions\\BooleanExtensions.cs" [[extensions]] name = "AndAlso" -sig = "bool AndAlso(this bool first, bool second)" returns = "bool" +sig = "bool AndAlso(this bool first, bool second)" summary = "Combines 2 boolean (And operation)." file = "Extensions\\BooleanExtensions.cs" [[extensions]] name = "OrElse" -sig = "bool OrElse(this bool first, bool second)" returns = "bool" +sig = "bool OrElse(this bool first, bool second)" summary = "Combines 2 boolean (Or operation)." file = "Extensions\\BooleanExtensions.cs" [[extensions]] name = "ToInteger" -sig = "int ToInteger(this bool value)" returns = "int" +sig = "int ToInteger(this bool value)" summary = "Gets a int from a boolean." file = "Extensions\\BooleanExtensions.cs" [[extensions]] name = "IsFalse" -sig = "bool IsFalse(this bool value)" returns = "bool" +sig = "bool IsFalse(this bool value)" summary = "Gets a value indicating if the value is False" file = "Extensions\\BooleanExtensions.cs" [[extensions]] name = "IfTrue" -sig = "void IfTrue(this bool value, Action action)" +returns = "T" +sig = "T IfTrue(this bool value, Func func)" +summary = "Execute func if value is True." +file = "Extensions\\BooleanExtensions.cs" + +[[extensions]] +name = "IfTrue" returns = "void" +sig = "void IfTrue(this bool value, Action action)" summary = "Execute action if value is True." file = "Extensions\\BooleanExtensions.cs" [[extensions]] name = "IfFalse" -sig = "void IfFalse(this bool value, Action action)" +returns = "T" +sig = "T IfFalse(this bool value, Func func)" +summary = "Execute func if value is False." +file = "Extensions\\BooleanExtensions.cs" + +[[extensions]] +name = "IfFalse" returns = "void" +sig = "void IfFalse(this bool value, Action action)" summary = "Execute action if value is False." file = "Extensions\\BooleanExtensions.cs" [[extensions]] name = "IfTrueOrFalse" -sig = "void IfTrueOrFalse(this bool value, Action actionTrue, Action actionFalse)" +returns = "T" +sig = "T IfTrueOrFalse(this bool value, Func funcTrue, Func funcFalse)" +summary = "Execute action if value is True/False." +file = "Extensions\\BooleanExtensions.cs" + +[[extensions]] +name = "IfTrueOrFalse" returns = "void" +sig = "void IfTrueOrFalse(this bool value, Action actionTrue, Action actionFalse)" summary = "Execute action if value is True/False." file = "Extensions\\BooleanExtensions.cs" [[extensions]] name = "ThrowArgumentOutOfRange" -sig = "void ThrowArgumentOutOfRange(this bool condition, string argumentName)" returns = "void" +sig = "void ThrowArgumentOutOfRange(this bool condition, string argumentName)" summary = "Checks an condition for True/False." file = "Extensions\\BooleanExtensions.cs" [[extensions]] name = "ToBooleanSafe" -sig = "bool ToBooleanSafe(this bool? value)" returns = "bool" +sig = "bool ToBooleanSafe(this bool? value)" summary = "Converts the nullable boolean to a boolean." file = "Extensions\\BooleanExtensions.cs" [[extensions]] name = "ToBooleanSafe" -sig = "bool ToBooleanSafe(this bool? value, bool defaultValue)" returns = "bool" +sig = "bool ToBooleanSafe(this bool? value, bool defaultValue)" summary = "Converts the nullable boolean to a boolean." file = "Extensions\\BooleanExtensions.cs" [[extensions]] name = "ToStringSafe" -sig = "string ToStringSafe(this bool? value)" returns = "string" +sig = "string ToStringSafe(this bool? value)" summary = "Converts the nullable boolean to a string." file = "Extensions\\BooleanExtensions.cs" @@ -184,282 +573,399 @@ static = true [[extensions]] name = "Count" -sig = "int Count(this IEnumerable source)" returns = "int" +sig = "int Count(this IEnumerable source)" file = "Extensions\\CollectionExtensions.cs" -[[classes]] -name = "ConcurrentListExtensions" -ns = "FEx.Agnostics.Abstractions.Extensions" -file = "Extensions\\ConcurrentListExtensions.cs" -static = true - -[[classes]] -name = "DateTimeExtensions" -ns = "FEx.Agnostics.Abstractions.Extensions" -file = "Extensions\\DateTimeExtensions.cs" -static = true +[[extensions]] +name = "IsNotNullOrEmptyCollection" +returns = "bool" +sig = "bool IsNotNullOrEmptyCollection(this ICollection source)" +file = "Extensions\\CollectionExtensions.cs" [[extensions]] -name = "InSqlRange" -sig = "bool InSqlRange(this DateTime value)" +name = "IsNullOrEmptyCollection" returns = "bool" -summary = "Gets a value indicating if value is between or equal Minimum - Maximum values for a SqlDateTime." -file = "Extensions\\DateTimeExtensions.cs" +sig = "bool IsNullOrEmptyCollection(this ICollection source)" +file = "Extensions\\CollectionExtensions.cs" [[extensions]] -name = "InSqlRangeOrNull" -sig = "bool InSqlRangeOrNull(this DateTime? value)" +name = "IsNotNullOrEmptyReadOnlyCollection" returns = "bool" -summary = "Gets a value indicating if value is between or equal Minimum - Maximum values for a SqlDateTime or is null." -file = "Extensions\\DateTimeExtensions.cs" +sig = "bool IsNotNullOrEmptyReadOnlyCollection(this IReadOnlyCollection source)" +file = "Extensions\\CollectionExtensions.cs" [[extensions]] -name = "InRange" -sig = "bool InRange(this DateTime value, DateTime min, DateTime max)" +name = "IsNullOrEmptyReadOnlyCollection" returns = "bool" -summary = "Gets a value indicating if value is between or equal Minimum - Maximum values." -file = "Extensions\\DateTimeExtensions.cs" +sig = "bool IsNullOrEmptyReadOnlyCollection(this IReadOnlyCollection source)" +file = "Extensions\\CollectionExtensions.cs" [[extensions]] -name = "GetWeekNumber" -sig = "int GetWeekNumber(this DateTime current)" -returns = "int" -summary = "Gets current week number." -file = "Extensions\\DateTimeExtensions.cs" +name = "BatchBy" +returns = "IEnumerable>" +sig = "IEnumerable> BatchBy(this IEnumerable source, int batchSize)" +file = "Extensions\\CollectionExtensions.cs" [[extensions]] -name = "IsAfter" -sig = "bool IsAfter(this DateTime? current, DateTime? target)" -returns = "bool" -summary = "Gets a value indicating whether a day is after a specified date." -file = "Extensions\\DateTimeExtensions.cs" +name = "AddRange" +returns = "void" +sig = "void AddRange(this ICollection source, IEnumerable items)" +summary = "Appends a sequence of items to an existing collection" +file = "Extensions\\CollectionExtensions.cs" [[extensions]] -name = "IsAfter" -sig = "bool IsAfter(this DateTime current, DateTime target)" -returns = "bool" -summary = "Gets a value indicating whether a day is after a specified date." -file = "Extensions\\DateTimeExtensions.cs" +name = "AddRangeToCollection" +returns = "void" +sig = "void AddRangeToCollection(this ICollection source, IEnumerable items)" +summary = "Appends a sequence of items to an existing collection" +file = "Extensions\\CollectionExtensions.cs" [[extensions]] -name = "IsAfterOrEqual" -sig = "bool IsAfterOrEqual(this DateTime current, DateTime target)" -returns = "bool" -summary = "Gets a value indicating whether a day is after or equal a specified date." -file = "Extensions\\DateTimeExtensions.cs" +name = "AddRangeToCollection" +returns = "void" +sig = "void AddRangeToCollection(this ICollection source, IList items)" +summary = "Appends a sequence of items to an existing collection" +file = "Extensions\\CollectionExtensions.cs" [[extensions]] -name = "IsBeforeOrEqual" -sig = "bool IsBeforeOrEqual(this DateTime current, DateTime target)" +name = "Remove" +returns = "void" +sig = "void Remove(this ICollection source, Func predicate)" +file = "Extensions\\CollectionExtensions.cs" + +[[extensions]] +name = "Remove" +returns = "void" +sig = "void Remove(this ICollection items, T item)" +file = "Extensions\\CollectionExtensions.cs" + +[[extensions]] +name = "Add" +returns = "void" +sig = "void Add(this ICollection items, T item, int count = 1, Func creator = null)" +summary = "Adds the specified item many times." +file = "Extensions\\CollectionExtensions.cs" + +[[extensions]] +name = "Flatten" +returns = "IEnumerable" +sig = "IEnumerable Flatten(this IEnumerable root, Func> predicate)" +file = "Extensions\\CollectionExtensions.cs" + +[[extensions]] +name = "ToObservableCollection" +returns = "ObservableCollection" +sig = "ObservableCollection ToObservableCollection(this IEnumerable source)" +file = "Extensions\\CollectionExtensions.cs" + +[[extensions]] +name = "ToReadOnlyList" +returns = "IReadOnlyList" +sig = "IReadOnlyList ToReadOnlyList(this IEnumerable collection)" +file = "Extensions\\CollectionExtensions.cs" + +[[extensions]] +name = "ToReadOnlyCollectionOrDefault" +returns = "IReadOnlyCollection" +sig = "IReadOnlyCollection ToReadOnlyCollectionOrDefault(this IEnumerable items, Func converter, IReadOnlyCollection defaultValue = null)" +file = "Extensions\\CollectionExtensions.cs" + +[[extensions]] +name = "Move" +returns = "void" +sig = "void Move(this IList list, T item, int newIndex)" +file = "Extensions\\CollectionExtensions.cs" + +[[classes]] +name = "ConcurrentListExtensions" +ns = "FEx.Agnostics.Abstractions.Extensions" +file = "Extensions\\ConcurrentListExtensions.cs" +static = true + +[[extensions]] +name = "AddUniqueRange" +returns = "void" +sig = "void AddUniqueRange(this IConcurrentList list, IEnumerable range, Func keySelector)" +file = "Extensions\\ConcurrentListExtensions.cs" + +[[extensions]] +name = "SortBy" +returns = "void" +sig = "void SortBy(this IConcurrentList list, Func selector)" +file = "Extensions\\ConcurrentListExtensions.cs" + +[[extensions]] +name = "SortBy" +returns = "void" +sig = "void SortBy(this IConcurrentList list, Func selector, ListSortDirection order)" +file = "Extensions\\ConcurrentListExtensions.cs" + +[[extensions]] +name = "Combo" +returns = "void" +sig = "void Combo(this IConcurrentList list, Action> action)" +file = "Extensions\\ConcurrentListExtensions.cs" + +[[classes]] +name = "DateTimeExtensions" +ns = "FEx.Agnostics.Abstractions.Extensions" +file = "Extensions\\DateTimeExtensions.cs" +static = true + +[[extensions]] +name = "InSqlRange" +returns = "bool" +sig = "bool InSqlRange(this DateTime value)" +summary = "Gets a value indicating if value is between or equal Minimum - Maximum values for a SqlDateTime." +file = "Extensions\\DateTimeExtensions.cs" + +[[extensions]] +name = "InSqlRangeOrNull" +returns = "bool" +sig = "bool InSqlRangeOrNull(this DateTime? value)" +summary = "Gets a value indicating if value is between or equal Minimum - Maximum values for a SqlDateTime or is null." +file = "Extensions\\DateTimeExtensions.cs" + +[[extensions]] +name = "InRange" +returns = "bool" +sig = "bool InRange(this DateTime value, DateTime min, DateTime max)" +summary = "Gets a value indicating if value is between or equal Minimum - Maximum values." +file = "Extensions\\DateTimeExtensions.cs" + +[[extensions]] +name = "GetWeekNumber" +returns = "int" +sig = "int GetWeekNumber(this DateTime current)" +summary = "Gets current week number." +file = "Extensions\\DateTimeExtensions.cs" + +[[extensions]] +name = "IsAfter" +returns = "bool" +sig = "bool IsAfter(this DateTime? current, DateTime? target)" +summary = "Gets a value indicating whether a day is after a specified date." +file = "Extensions\\DateTimeExtensions.cs" + +[[extensions]] +name = "IsAfter" +returns = "bool" +sig = "bool IsAfter(this DateTime current, DateTime target)" +summary = "Gets a value indicating whether a day is after a specified date." +file = "Extensions\\DateTimeExtensions.cs" + +[[extensions]] +name = "IsAfterOrEqual" returns = "bool" +sig = "bool IsAfterOrEqual(this DateTime current, DateTime target)" summary = "Gets a value indicating whether a day is after or equal a specified date." file = "Extensions\\DateTimeExtensions.cs" +[[extensions]] +name = "IsBeforeOrEqual" +returns = "bool" +sig = "bool IsBeforeOrEqual(this DateTime current, DateTime target)" +file = "Extensions\\DateTimeExtensions.cs" + [[extensions]] name = "ToDaySuffix" -sig = "string ToDaySuffix(this int day)" returns = "string" -summary = "Gets a value indicating whether a day is after or equal a specified date." +sig = "string ToDaySuffix(this int day)" file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "GetStartOfWeek" -sig = "DateTime GetStartOfWeek(this DateTime date)" returns = "DateTime" -summary = "Gets a value indicating whether a day is after or equal a specified date." +sig = "DateTime GetStartOfWeek(this DateTime date)" file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "ConvertDateBetweenTimeZones" -sig = "DateTime ConvertDateBetweenTimeZones(this DateTime date, - TimeZoneInfo timeZoneFrom, - TimeZoneInfo timeZoneTo)" returns = "DateTime" -summary = "Gets a value indicating whether a day is after or equal a specified date." +sig = "DateTime ConvertDateBetweenTimeZones(this DateTime date, TimeZoneInfo timeZoneFrom, TimeZoneInfo timeZoneTo)" file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "ConvertLocalToTimeZone" -sig = "DateTime ConvertLocalToTimeZone(this DateTime dateTime, TimeZoneInfo timeZone)" returns = "DateTime" -summary = "Gets a value indicating whether a day is after or equal a specified date." +sig = "DateTime ConvertLocalToTimeZone(this DateTime dateTime, TimeZoneInfo timeZone)" file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "GetLastDayOfMonth" -sig = "DateTime GetLastDayOfMonth(this DateTime date)" returns = "DateTime" +sig = "DateTime GetLastDayOfMonth(this DateTime date)" summary = "Gets the date of last day of month." file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "RoundUp" -sig = "DateTime RoundUp(this DateTime dateToRound, TimeSpan roundTo)" returns = "DateTime" +sig = "DateTime RoundUp(this DateTime dateToRound, TimeSpan roundTo)" summary = "Get a new date rounded to the specified time or a multiple of it" file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "IsWeekend" -sig = "bool IsWeekend(this DateTime current)" returns = "bool" +sig = "bool IsWeekend(this DateTime current)" summary = "Gets whether the the provided date is on a Weekend." file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "IsWeekDay" -sig = "bool IsWeekDay(this DateTime current)" returns = "bool" +sig = "bool IsWeekDay(this DateTime current)" summary = "Gets whether the the provided date is on a Week Day." file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "IsLeapYear" -sig = "bool IsLeapYear(this DateTime current)" returns = "bool" +sig = "bool IsLeapYear(this DateTime current)" summary = "Gets a value indicating whether the the provided date is in a leap year." file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "GetCountDaysOfMonth" -sig = "int GetCountDaysOfMonth(this DateTime current)" returns = "int" +sig = "int GetCountDaysOfMonth(this DateTime current)" summary = "Gets the number of days in the month of the provided date." file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "ToA4DTimeString" -sig = "string ToA4DTimeString(this DateTime current)" returns = "string" +sig = "string ToA4DTimeString(this DateTime current)" summary = "Gets a formatted datestring from a date." file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "ToA4DDateTimeString" -sig = "string ToA4DDateTimeString(this DateTime current)" returns = "string" -summary = "Gets a formatted datestring from a date." +sig = "string ToA4DDateTimeString(this DateTime current)" file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "ClearMilliseconds" -sig = "DateTime ClearMilliseconds(this DateTime dateTime)" returns = "DateTime" +sig = "DateTime ClearMilliseconds(this DateTime dateTime)" summary = "Clears the milliseconds." file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "IsEarlierThan" -sig = "bool IsEarlierThan(this DateTime firstDateTime, DateTime secondDateTime)" returns = "bool" -summary = "Clears the milliseconds." +sig = "bool IsEarlierThan(this DateTime firstDateTime, DateTime secondDateTime)" file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "IsTheSameTimeAs" -sig = "bool IsTheSameTimeAs(this DateTime firstDateTime, DateTime secondDateTime)" returns = "bool" -summary = "Clears the milliseconds." +sig = "bool IsTheSameTimeAs(this DateTime firstDateTime, DateTime secondDateTime)" file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "IsLaterThan" -sig = "bool IsLaterThan(this DateTime firstDateTime, DateTime secondDateTime)" returns = "bool" -summary = "Clears the milliseconds." +sig = "bool IsLaterThan(this DateTime firstDateTime, DateTime secondDateTime)" +file = "Extensions\\DateTimeExtensions.cs" + +[[methods]] +parent = "DateTimeExtensions" +name = "GetCurrentUnixTimestampMillis" +sig = "static long GetCurrentUnixTimestampMillis()" +returns = "long" file = "Extensions\\DateTimeExtensions.cs" +static = true [[extensions]] name = "DateTimeFromUnixTimestampMillis" -sig = "DateTime DateTimeFromUnixTimestampMillis(this long millis)" returns = "DateTime" -summary = "Clears the milliseconds." +sig = "DateTime DateTimeFromUnixTimestampMillis(this long millis)" file = "Extensions\\DateTimeExtensions.cs" +[[methods]] +parent = "DateTimeExtensions" +name = "GetCurrentUnixTimestampSeconds" +sig = "static long GetCurrentUnixTimestampSeconds()" +returns = "long" +file = "Extensions\\DateTimeExtensions.cs" +static = true + [[extensions]] name = "DateTimeFromUnixTimestampSeconds" -sig = "DateTime DateTimeFromUnixTimestampSeconds(this long seconds)" returns = "DateTime" -summary = "Clears the milliseconds." +sig = "DateTime DateTimeFromUnixTimestampSeconds(this long seconds)" file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "GetUnixTimeFromDate" -sig = "long GetUnixTimeFromDate(this DateTime theTime)" returns = "long" -summary = "Clears the milliseconds." +sig = "long GetUnixTimeFromDate(this DateTime theTime)" file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "GetUnixTimeFromDateSeconds" -sig = "long GetUnixTimeFromDateSeconds(this DateTime theTime)" returns = "long" -summary = "Clears the milliseconds." +sig = "long GetUnixTimeFromDateSeconds(this DateTime theTime)" file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "FromTicks" -sig = "DateTime FromTicks(this long ticks)" returns = "DateTime" +sig = "DateTime FromTicks(this long ticks)" file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "GetLocalizedShortTimeString" -sig = "string GetLocalizedShortTimeString(this DateTime date, CultureInfo culture)" returns = "string" +sig = "string GetLocalizedShortTimeString(this DateTime date, CultureInfo culture)" file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "GetLocalizedFullDateTimeString" -sig = "string GetLocalizedFullDateTimeString(this DateTime date, string format = \"dd.MM.yyyy HH:mm\")" returns = "string" +sig = "string GetLocalizedFullDateTimeString(this DateTime date, string format = \"dd.MM.yyyy HH:mm\")" file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "GetLocalizedDateString" -sig = "string GetLocalizedDateString(this DateTime date, string format = \"dd.MM.yyyy\")" returns = "string" +sig = "string GetLocalizedDateString(this DateTime date, string format = \"dd.MM.yyyy\")" file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "GetLocalizedDayOfWeek" -sig = "string GetLocalizedDayOfWeek(this DayOfWeek dayOfWeek, CultureInfo culture)" returns = "string" +sig = "string GetLocalizedDayOfWeek(this DayOfWeek dayOfWeek, CultureInfo culture)" file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "DateDiffIsBetween" -sig = "bool DateDiffIsBetween(this DateTime date1, - DateTime date2, - DateInterval interval, - double min, - double max, - DayOfWeek? dayOfWeek = null)" returns = "bool" +sig = "bool DateDiffIsBetween(this DateTime date1, DateTime date2, DateInterval interval, double min, double max, DayOfWeek? dayOfWeek = null)" summary = "Compares the difference between and in the specified interval, and returns whether this difference is between the bounds given." file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "DateDiff" -sig = "double DateDiff(this DateTime date1, - DateTime date2, - DateInterval interval, - DayOfWeek? dayOfWeek = null)" returns = "double" +sig = "double DateDiff(this DateTime date1, DateTime date2, DateInterval interval, DayOfWeek? dayOfWeek = null)" summary = "Returns a specifying the number of time intervals between two values." file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "GetDay" -sig = "double GetDay(this DayOfWeek weekday)" returns = "double" +sig = "double GetDay(this DayOfWeek weekday)" file = "Extensions\\DateTimeExtensions.cs" [[extensions]] name = "GetDayOfWeek" -sig = "DayOfWeek GetDayOfWeek(this DateTime dt, DayOfWeek? weekdayFirst = null)" returns = "DayOfWeek" +sig = "DayOfWeek GetDayOfWeek(this DateTime dt, DayOfWeek? weekdayFirst = null)" file = "Extensions\\DateTimeExtensions.cs" [[classes]] @@ -469,6 +975,110 @@ summary = "IDictionary extensions class." file = "Extensions\\DictionaryExtensions.cs" static = true +[[extensions]] +name = "TryGetKeyValue" +returns = "TValue" +sig = "TValue TryGetKeyValue(this IDictionary dictionary, TKey key, TValue fallback = default)" +summary = "Tries to get key value." +file = "Extensions\\DictionaryExtensions.cs" + +[[extensions]] +name = "GetValue" +returns = "(bool isSuccess, TV value)" +sig = "(bool isSuccess, TV value) GetValue(this IDictionary dictionary, TK key)" +file = "Extensions\\DictionaryExtensions.cs" + +[[extensions]] +name = "AddRangeToDictionary" +returns = "void" +sig = "void AddRangeToDictionary(this IDictionary dictionary, IEnumerable> merged)" +summary = "Adds the range." +file = "Extensions\\DictionaryExtensions.cs" + +[[extensions]] +name = "ToMergedDictionary" +returns = "IDictionary>" +sig = "IDictionary> ToMergedDictionary(this IDictionary> source, Func keySelector, Func, IEnumerable> valuesSelector)" +summary = "Transforms to the merged dictionary." +file = "Extensions\\DictionaryExtensions.cs" + +[[extensions]] +name = "Merge" +returns = "IDictionary>" +sig = "IDictionary> Merge( this IDictionary> source, IDictionary> merged)" +summary = "Merges the specified dictionaries." +file = "Extensions\\DictionaryExtensions.cs" + +[[extensions]] +name = "GetOrAddValue" +returns = "TV" +sig = "TV GetOrAddValue(this IDictionary dictionary, TK key, Func createValueToAdd)" +summary = "Returns the value in an IDictionary at the given key, or creates a new value using the given delegate, adds it at the given key, and returns the new value." +file = "Extensions\\DictionaryExtensions.cs" + +[[extensions]] +name = "AddOrUpdateValue" +returns = "TV" +sig = "TV AddOrUpdateValue(this IDictionary dictionary, TK key, TV valueToAddOrUpdate)" +summary = "Adds a key/value pair to the if the key does not already exist, or updates a key/value pair in the by using the specified function." +file = "Extensions\\DictionaryExtensions.cs" + +[[extensions]] +name = "AddOrUpdateValue" +returns = "TV" +sig = "TV AddOrUpdateValue(this IDictionary dictionary, TK key, Func valueToAddOrUpdate)" +summary = "Adds a key/value pair to the if the key does not already exist, or updates a key/value pair in the by using the specified function." +file = "Extensions\\DictionaryExtensions.cs" + +[[extensions]] +name = "AddOrReplaceValue" +returns = "(bool hasBeenReplaced, TV removedValue, TV newValue)" +sig = "(bool hasBeenReplaced, TV removedValue, TV newValue) AddOrReplaceValue( this IDictionary dictionary, TK key, Func valueToAddOrUpdate)" +summary = "Adds a key/value pair to the if the key does not already exist, or updates a key/value pair in the by using the specified function." +file = "Extensions\\DictionaryExtensions.cs" + +[[extensions]] +name = "TryAddValue" +returns = "bool" +sig = "bool TryAddValue(this IDictionary dictionary, TK key, Func createValueToAdd)" +file = "Extensions\\DictionaryExtensions.cs" + +[[extensions]] +name = "RemoveValue" +returns = "(bool hasBeenRemoved, TV removedValue)" +sig = "(bool hasBeenRemoved, TV removedValue) RemoveValue( this IDictionary dictionary, TK key)" +file = "Extensions\\DictionaryExtensions.cs" + +[[extensions]] +name = "ReplaceAndDisposeOldValue" +returns = "bool" +sig = "bool ReplaceAndDisposeOldValue(this IDictionary dictionary, TK key, Func func)" +file = "Extensions\\DictionaryExtensions.cs" + +[[extensions]] +name = "RemoveFromDictionaryWhere" +returns = "(bool anyItemHasMatched, IDictionary removedEntries)" +sig = "(bool anyItemHasMatched, IDictionary removedEntries) RemoveFromDictionaryWhere( this IDictionary dictionary, Func predicate)" +file = "Extensions\\DictionaryExtensions.cs" + +[[extensions]] +name = "SyncWith" +returns = "void" +sig = "void SyncWith(this IDictionary sourceDictionary, IDictionary syncedDictionary)" +file = "Extensions\\DictionaryExtensions.cs" + +[[extensions]] +name = "IsNotNullOrEmptyDictionary" +returns = "bool" +sig = "bool IsNotNullOrEmptyDictionary(this IDictionary dictionary)" +file = "Extensions\\DictionaryExtensions.cs" + +[[extensions]] +name = "IsNullOrEmptyDictionary" +returns = "bool" +sig = "bool IsNullOrEmptyDictionary(this IDictionary dictionary)" +file = "Extensions\\DictionaryExtensions.cs" + [[classes]] name = "DirectoryInfoExtensions" ns = "FEx.Agnostics.Abstractions.Extensions" @@ -477,39 +1087,50 @@ static = true [[extensions]] name = "IsNtfs" -sig = "bool IsNtfs(this DirectoryInfo dir)" returns = "bool" +sig = "bool IsNtfs(this DirectoryInfo dir)" file = "Extensions\\DirectoryInfoExtensions.cs" [[extensions]] name = "GetDescendantPath" -sig = "string GetDescendantPath(this DirectoryInfo dir, params string[] descendants)" returns = "string" +sig = "string GetDescendantPath(this DirectoryInfo dir, params string[] descendants)" file = "Extensions\\DirectoryInfoExtensions.cs" [[extensions]] name = "GetDescendantFile" -sig = "FileInfo GetDescendantFile(this DirectoryInfo dir, params string[] descendants)" returns = "FileInfo" +sig = "FileInfo GetDescendantFile(this DirectoryInfo dir, params string[] descendants)" file = "Extensions\\DirectoryInfoExtensions.cs" [[extensions]] name = "GetDescendantDirectory" -sig = "DirectoryInfo GetDescendantDirectory(this DirectoryInfo dir, params string[] descendants)" returns = "DirectoryInfo" +sig = "DirectoryInfo GetDescendantDirectory(this DirectoryInfo dir, params string[] descendants)" +file = "Extensions\\DirectoryInfoExtensions.cs" + +[[extensions]] +name = "GetDescendantFileSystemObject" +returns = "T" +sig = "T GetDescendantFileSystemObject(this string directoryPath, Func activator, params string[] descendants)" +file = "Extensions\\DirectoryInfoExtensions.cs" + +[[extensions]] +name = "GetDescendantFileSystemObject" +returns = "T" +sig = "T GetDescendantFileSystemObject(this DirectoryInfo dir, Func activator, params string[] descendants)" file = "Extensions\\DirectoryInfoExtensions.cs" [[extensions]] name = "GetSpecialDirectoryPathDescendants" -sig = "string GetSpecialDirectoryPathDescendants(this Environment.SpecialFolder folder, - params string[] descendants)" returns = "string" +sig = "string GetSpecialDirectoryPathDescendants(this Environment.SpecialFolder folder, params string[] descendants)" file = "Extensions\\DirectoryInfoExtensions.cs" [[extensions]] name = "GetSpecialDirectory" -sig = "SpecialDirectory GetSpecialDirectory(this Environment.SpecialFolder folder)" returns = "SpecialDirectory" +sig = "SpecialDirectory GetSpecialDirectory(this Environment.SpecialFolder folder)" file = "Extensions\\DirectoryInfoExtensions.cs" [[classes]] @@ -521,19 +1142,26 @@ static = true [[extensions]] name = "GetDynamicMemberNames" -sig = "IEnumerable GetDynamicMemberNames(this ExpandoObject expandoObject)" returns = "IEnumerable" +sig = "IEnumerable GetDynamicMemberNames(this ExpandoObject expandoObject)" summary = "Gets the dynamic member names." file = "Extensions\\DynamicExtensions.cs" [[extensions]] name = "AddPropertiesFromDictionary" -sig = "dynamic AddPropertiesFromDictionary(this ExpandoObject eo, - IDictionary propsDictionary)" returns = "dynamic" +sig = "dynamic AddPropertiesFromDictionary(this ExpandoObject eo, IDictionary propsDictionary)" summary = "Adds the properties from dictionary." file = "Extensions\\DynamicExtensions.cs" +[[methods]] +parent = "DynamicExtensions" +name = "DynamicObjectToDictionary" +sig = "static IDictionary DynamicObjectToDictionary(dynamic src)" +returns = "IDictionary" +file = "Extensions\\DynamicExtensions.cs" +static = true + [[classes]] name = "EnumerableExtensions" ns = "FEx.Agnostics.Abstractions.Extensions" @@ -542,37 +1170,198 @@ static = true [[extensions]] name = "Any" -sig = "bool Any(this IEnumerable source)" returns = "bool" +sig = "bool Any(this IEnumerable source)" file = "Extensions\\EnumerableExtensions.cs" [[extensions]] name = "HasAny" +returns = "bool" sig = "bool HasAny(this IEnumerable enumerable)" +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "HasAny" +returns = "bool" +sig = "bool HasAny(this IEnumerable enumerable)" +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "FindInEnumerable" +returns = "T" +sig = "T FindInEnumerable(this IEnumerable source, Func predicate = null)" +summary = "Searches for an element that matches the conditions defined by the specified predicate, and returns the first occurrence." +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "None" +returns = "bool" +sig = "bool None(this IEnumerable source, Func predicate = null)" +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "IsNullOrEmptyEnumerable" +returns = "bool" +sig = "bool IsNullOrEmptyEnumerable(this IEnumerable source)" +summary = "Determines whether I'm null or empty." +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "IsNotNullOrEmptyEnumerable" returns = "bool" +sig = "bool IsNotNullOrEmptyEnumerable(this IEnumerable source)" +file = "Extensions\\EnumerableExtensions.cs" + +[[methods]] +parent = "EnumerableExtensions" +name = "AddRange" +sig = "static void AddRange(ref IEnumerable source, IEnumerable items)" +returns = "void" +summary = "Appends a sequence of items to an existing list" file = "Extensions\\EnumerableExtensions.cs" +static = true [[extensions]] name = "AggregateSafe" -sig = "string AggregateSafe(this IEnumerable source)" returns = "string" +sig = "string AggregateSafe(this IEnumerable source)" summary = "Aggregates a list of strings." file = "Extensions\\EnumerableExtensions.cs" +[[extensions]] +name = "ForEachInEnumerable" +returns = "void" +sig = "void ForEachInEnumerable(this IEnumerable source, Action action)" +summary = "Execute a action for each item in the list." +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "MultiplyBy" +returns = "IEnumerable" +sig = "IEnumerable MultiplyBy(this IEnumerable items, int multiplier)" +summary = "Multiplies the items by given multiplier number." +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "Divide" +returns = "IEnumerable>" +sig = "IEnumerable> Divide(this IEnumerable items, int maxNumberOfItems)" +summary = "Divides the specified set of items into sets of smaller ones (less than given maximum number of items)." +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "MaxOrDefault" +returns = "TResult" +sig = "TResult MaxOrDefault(this IEnumerable items, Func selector)" +summary = "Maximums the or default." +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "ToJoinedString" +returns = "string" +sig = "string ToJoinedString(this IEnumerable items)" +summary = "Builds the joined string." +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "ToObservableCollection" +returns = "ObservableCollection" +sig = "ObservableCollection ToObservableCollection(this IEnumerable source)" +summary = "Converts to the ." +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "IndexOf" +returns = "int" +sig = "int IndexOf(this IEnumerable items, T item)" +summary = "Finds the index of the first occurrence of an item in an enumerable." +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "IndexWhere" +returns = "int" +sig = "int IndexWhere(this IEnumerable source, Func predicate)" +summary = "Gets index of first element where condition is met." +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "IndexesWhere" +returns = "IEnumerable" +sig = "IEnumerable IndexesWhere(this IEnumerable source, Func predicate)" +summary = "Gets indexes of all elements where condition is met." +file = "Extensions\\EnumerableExtensions.cs" + [[extensions]] name = "GetItemType" -sig = "Type GetItemType(this IEnumerable enumerable)" returns = "Type" +sig = "Type GetItemType(this IEnumerable enumerable)" summary = "Gets the type of the item." file = "Extensions\\EnumerableExtensions.cs" [[extensions]] name = "UnorderedSequenceEqual" +returns = "bool" sig = "bool UnorderedSequenceEqual(this IEnumerable first, IEnumerable second)" +summary = "Checks if two sequences contain the same elements without checking their order" +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "UnorderedSequenceEqual" returns = "bool" +sig = "bool UnorderedSequenceEqual(this IEnumerable first, IEnumerable second)" summary = "Checks if two sequences contain the same elements without checking their order" file = "Extensions\\EnumerableExtensions.cs" +[[extensions]] +name = "ToCollection" +returns = "Collection" +sig = "Collection ToCollection(this IEnumerable source)" +summary = "To the collection." +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "TakeLast" +returns = "IEnumerable" +sig = "IEnumerable TakeLast(this IEnumerable source, int n)" +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "MulitplyBy" +returns = "IList>" +sig = "IList> MulitplyBy(this IEnumerable> origin, IEnumerable multiplier)" +summary = "Multiplies the given IEnumerables by given one (builds cartesian result)." +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "CountEqualItems" +returns = "int" +sig = "int CountEqualItems(this IEnumerable sourceA, IEnumerable sourceB)" +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "GetAllItemsChildren" +returns = "IEnumerable" +sig = "IEnumerable GetAllItemsChildren(this IEnumerable items, Func> getChildrenFunc)" +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "GetAllItemChildren" +returns = "IEnumerable" +sig = "IEnumerable GetAllItemChildren(this T item, Func> getChildrenFunc)" +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "SortBy" +returns = "IOrderedEnumerable" +sig = "IOrderedEnumerable SortBy(this IEnumerable items, Func selector, ListSortDirection order = ListSortDirection.Ascending, IComparer comparer = null)" +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "IndexOfEnumerable" +returns = "int" +sig = "int IndexOfEnumerable(this IEnumerable items, T itemToFind)" +file = "Extensions\\EnumerableExtensions.cs" + [[classes]] name = "EnumExtensions" ns = "FEx.Agnostics.Abstractions.Extensions" @@ -581,11 +1370,62 @@ static = true [[extensions]] name = "GetEnumValueDescription" -sig = "string GetEnumValueDescription(this Enum enumValue)" returns = "string" +sig = "string GetEnumValueDescription(this Enum enumValue)" summary = "Gets the enum value description." file = "Extensions\\EnumExtensions.cs" +[[extensions]] +name = "GetEnumValueAttribute" +returns = "TAttributeType" +sig = "TAttributeType GetEnumValueAttribute(this Enum enumValue)" +summary = "Generic method getting attribute object of the given type from enumerated value." +file = "Extensions\\EnumExtensions.cs" + +[[extensions]] +name = "GetEnumValueAttributes" +returns = "TAttributeType[]" +sig = "TAttributeType[] GetEnumValueAttributes(this Enum enumValue)" +summary = "Generic method getting attribute objects of the given type from enumerated value." +file = "Extensions\\EnumExtensions.cs" + +[[extensions]] +name = "TryParse" +returns = "TEnum?" +sig = "TEnum? TryParse(this string value, bool ignoreCase = false)" +file = "Extensions\\EnumExtensions.cs" + +[[extensions]] +name = "GetEnumValues" +returns = "IReadOnlyCollection" +sig = "IReadOnlyCollection GetEnumValues(this TEnum _)" +file = "Extensions\\EnumExtensions.cs" + +[[methods]] +parent = "EnumExtensions" +name = "GetEnumValues" +sig = "static IReadOnlyCollection GetEnumValues() where TEnum : struct, Enum" +returns = "IReadOnlyCollection" +summary = "Gets the enum values." +file = "Extensions\\EnumExtensions.cs" +static = true + +[[methods]] +parent = "EnumExtensions" +name = "GetEnumMap" +sig = "static IMap GetEnumMap(bool useValueDescription = false) where TEnum : struct, Enum" +returns = "IMap" +file = "Extensions\\EnumExtensions.cs" +static = true + +[[methods]] +parent = "EnumExtensions" +name = "GetEnumCustomMap" +sig = "static IMap GetEnumCustomMap(Func keyGetter, Func valueGetter) where TEnum : struct, Enum" +returns = "IMap" +file = "Extensions\\EnumExtensions.cs" +static = true + [[classes]] name = "ErrorExtensions" ns = "FEx.Agnostics.Abstractions.Extensions" @@ -594,20 +1434,32 @@ static = true [[extensions]] name = "GetErrorRoot" -sig = "IError GetErrorRoot(this IError error)" returns = "IError" +sig = "IError GetErrorRoot(this IError error)" +file = "Extensions\\ErrorExtensions.cs" + +[[extensions]] +name = "TryGetError" +returns = "bool" +sig = "bool TryGetError(this IError error, out TError foundError)" +file = "Extensions\\ErrorExtensions.cs" + +[[extensions]] +name = "Wrap" +returns = "TError" +sig = "TError Wrap(this IError errorToWrap)" file = "Extensions\\ErrorExtensions.cs" [[extensions]] name = "ToAggregatedError" -sig = "AggregatedError ToAggregatedError(this IError error)" returns = "AggregatedError" +sig = "AggregatedError ToAggregatedError(this IError error)" file = "Extensions\\ErrorExtensions.cs" [[extensions]] name = "ToAggregateException" -sig = "AggregateException ToAggregateException(this AggregatedError error)" returns = "AggregateException" +sig = "AggregateException ToAggregateException(this AggregatedError error)" file = "Extensions\\ErrorExtensions.cs" [[classes]] @@ -618,26 +1470,26 @@ static = true [[extensions]] name = "HandlePropertyChanged" -sig = "void HandlePropertyChanged(this PropertyChangedEventHandler handler, - object sender, - string propertyName)" returns = "void" +sig = "void HandlePropertyChanged(this PropertyChangedEventHandler handler, object sender, string propertyName)" file = "Extensions\\EventsExtensions.cs" [[extensions]] name = "HandlePropertyChanged" -sig = "void HandlePropertyChanged(this PropertyChangedEventHandler propertyChangedEventHandler, - object sender, - PropertyChangedEventArgs eventArgs)" returns = "void" +sig = "void HandlePropertyChanged(this PropertyChangedEventHandler propertyChangedEventHandler, object sender, PropertyChangedEventArgs eventArgs)" file = "Extensions\\EventsExtensions.cs" [[extensions]] name = "HandleCollectionChanged" -sig = "void HandleCollectionChanged(this NotifyCollectionChangedEventHandler collectionChangedEventHandler, - object sender, - NotifyCollectionChangedEventArgs eventArgs)" returns = "void" +sig = "void HandleCollectionChanged(this NotifyCollectionChangedEventHandler collectionChangedEventHandler, object sender, NotifyCollectionChangedEventArgs eventArgs)" +file = "Extensions\\EventsExtensions.cs" + +[[extensions]] +name = "HandleMulticastEvent" +returns = "void" +sig = "void HandleMulticastEvent(this THandler handler, object sender, TArgs eventArgs, Action defaultInvocation)" file = "Extensions\\EventsExtensions.cs" [[classes]] @@ -648,18 +1500,32 @@ static = true [[extensions]] name = "SetStackTrace" -sig = "Exception SetStackTrace(this Exception target, StackTrace stack)" returns = "Exception" +sig = "Exception SetStackTrace(this Exception target, StackTrace stack)" summary = "Sets the stack trace of provided exception object" file = "Extensions\\ExceptionExtensions.cs" [[extensions]] name = "BuildMessage" -sig = "string BuildMessage(this Exception ex)" returns = "string" +sig = "string BuildMessage(this Exception ex)" summary = "Gets a formatted string from the exception." file = "Extensions\\ExceptionExtensions.cs" +[[extensions]] +name = "Stack" +returns = "string" +sig = "string Stack(this T self)" +summary = "Stacks the specified self." +file = "Extensions\\ExceptionExtensions.cs" + +[[extensions]] +name = "History" +returns = "IEnumerable" +sig = "IEnumerable History(this T self)" +summary = "Gets the innerexceptions from a exception." +file = "Extensions\\ExceptionExtensions.cs" + [[classes]] name = "FExLoggerExtensions" ns = "FEx.Agnostics.Abstractions.Extensions" @@ -668,38 +1534,38 @@ static = true [[extensions]] name = "Trace" -sig = "void Trace(this IFExLogger logger, Exception exception)" returns = "void" +sig = "void Trace(this IFExLogger logger, Exception exception)" file = "Extensions\\FExLoggerExtensions.cs" [[extensions]] name = "Debug" -sig = "void Debug(this IFExLogger logger, Exception exception)" returns = "void" +sig = "void Debug(this IFExLogger logger, Exception exception)" file = "Extensions\\FExLoggerExtensions.cs" [[extensions]] name = "Information" -sig = "void Information(this IFExLogger logger, Exception exception)" returns = "void" +sig = "void Information(this IFExLogger logger, Exception exception)" file = "Extensions\\FExLoggerExtensions.cs" [[extensions]] name = "Warning" -sig = "void Warning(this IFExLogger logger, Exception exception)" returns = "void" +sig = "void Warning(this IFExLogger logger, Exception exception)" file = "Extensions\\FExLoggerExtensions.cs" [[extensions]] name = "Error" -sig = "void Error(this IFExLogger logger, Exception exception)" returns = "void" +sig = "void Error(this IFExLogger logger, Exception exception)" file = "Extensions\\FExLoggerExtensions.cs" [[extensions]] name = "Critical" -sig = "void Critical(this IFExLogger logger, Exception exception)" returns = "void" +sig = "void Critical(this IFExLogger logger, Exception exception)" file = "Extensions\\FExLoggerExtensions.cs" [[classes]] @@ -710,36 +1576,49 @@ static = true [[extensions]] name = "CompareSize" -sig = "int CompareSize(this FileInfo file, long otherFileSize)" returns = "int" +sig = "int CompareSize(this FileInfo file, long otherFileSize)" summary = "Compares the size." file = "Extensions\\FileInfoExtensions.cs" +[[extensions]] +name = "ZipAsync" +returns = "Task" +sig = "Task ZipAsync(this FileInfo file, string zipFilePath = null, bool deleteTempDirectory = false, bool overwrite = false)" +summary = "Creates ZIP archive from file." +file = "Extensions\\FileInfoExtensions.cs" + +[[extensions]] +name = "ZipAsync" +returns = "Task" +sig = "Task ZipAsync(this FileInfo file, FileInfo zipFile = null, bool deleteTempDirectory = false, bool overwrite = false)" +file = "Extensions\\FileInfoExtensions.cs" + [[extensions]] name = "GenerateMd5OfFile" -sig = "string GenerateMd5OfFile(this FileInfo file, - bool removeDashes = true, - bool toLower = true, - bool asBase64String = false)" returns = "string" +sig = "string GenerateMd5OfFile(this FileInfo file, bool removeDashes = true, bool toLower = true, bool asBase64String = false)" file = "Extensions\\FileInfoExtensions.cs" [[extensions]] name = "IsNtfs" -sig = "bool IsNtfs(this FileInfo file)" returns = "bool" +sig = "bool IsNtfs(this FileInfo file)" file = "Extensions\\FileInfoExtensions.cs" [[extensions]] name = "ComputeMd5Hash" -sig = "string ComputeMd5Hash(this byte[] data, - bool removeDashes = true, - bool toLower = true, - bool asBase64String = false)" returns = "string" +sig = "string ComputeMd5Hash(this byte[] data, bool removeDashes = true, bool toLower = true, bool asBase64String = false)" summary = "Computes the md5 hash." file = "Extensions\\FileInfoExtensions.cs" +[[extensions]] +name = "ToMemoryStreamAsync" +returns = "Task" +sig = "Task ToMemoryStreamAsync(this FileInfo file)" +file = "Extensions\\FileInfoExtensions.cs" + [[classes]] name = "FileSystemInfoExtensions" ns = "FEx.Agnostics.Abstractions.Extensions" @@ -748,14 +1627,14 @@ static = true [[extensions]] name = "GetDirectory" -sig = "DirectoryInfo GetDirectory(this FileSystemInfo fileSystemInfo)" returns = "DirectoryInfo" +sig = "DirectoryInfo GetDirectory(this FileSystemInfo fileSystemInfo)" file = "Extensions\\FileSystemInfoExtensions.cs" [[extensions]] name = "IsPathFile" -sig = "bool IsPathFile(this FileSystemInfo fileSystemInfo)" returns = "bool" +sig = "bool IsPathFile(this FileSystemInfo fileSystemInfo)" file = "Extensions\\FileSystemInfoExtensions.cs" [[classes]] @@ -764,30 +1643,106 @@ ns = "FEx.Agnostics.Abstractions.Extensions" file = "Extensions\\GuardExtensions.cs" static = true +[[extensions]] +name = "GuardProperty" +returns = "T" +sig = "T GuardProperty([CanBeNull] this T value, string message = null, [CallerMemberName] string paramName = null)" +summary = "Guards if provided value is not null, otherwise throws an exception of type with a specific when the precondition has not been met" +file = "Extensions\\GuardExtensions.cs" + +[[extensions]] +name = "Guard" +returns = "T" +sig = "T Guard([CanBeNull] this T value, string paramName)" +summary = "Guards if provided value is not null, otherwise throws an exception of type with a specific when the precondition has not been met" +file = "Extensions\\GuardExtensions.cs" + +[[extensions]] +name = "Guard" +returns = "T" +sig = "T Guard([CanBeNull] this T value, string paramName, string message)" +file = "Extensions\\GuardExtensions.cs" + +[[extensions]] +name = "Guard" +returns = "T" +sig = "T Guard([CanBeNull] this T value, Func predicate, string paramName)" +summary = "Guards the specified from being violated by throwing an exception of type with a specific when the precondition has not been met" +file = "Extensions\\GuardExtensions.cs" + +[[extensions]] +name = "Guard" +returns = "T" +sig = "T Guard([CanBeNull] this T value, Func predicate, string paramName, string message)" +file = "Extensions\\GuardExtensions.cs" + [[classes]] name = "InitializationExtensions" ns = "FEx.Agnostics.Abstractions.Extensions" file = "Extensions\\InitializationExtensions.cs" static = true +[[extensions]] +name = "InitializeAll" +returns = "void" +sig = "void InitializeAll(this ICollection initializers)" +file = "Extensions\\InitializationExtensions.cs" + [[classes]] name = "LambdaExtensions" ns = "FEx.Agnostics.Abstractions.Extensions" file = "Extensions\\LambdaExtensions.cs" static = true +[[properties]] +parent = "LambdaExtensions" +name = "TrueExp" +sig = "static Expression> TrueExp { get; }" +returns = "Expression>" +summary = "Returns a expression that always returns true" +file = "Extensions\\LambdaExtensions.cs" +static = true + +[[properties]] +parent = "LambdaExtensions" +name = "FalseExp" +sig = "static Expression> FalseExp { get; }" +returns = "Expression>" +summary = "Returns a expression that always returns false" +file = "Extensions\\LambdaExtensions.cs" +static = true + [[classes]] name = "LambdaExtensions" ns = "FEx.Agnostics.Abstractions.Extensions" -summary = "Returns a expression that always returns false" file = "Extensions\\LambdaExtensions.cs" static = true +[[extensions]] +name = "And" +returns = "Expression>" +sig = "Expression> And(this Expression> first, Expression> second)" +summary = "Combines 2 expressions with an logical AND." +file = "Extensions\\LambdaExtensions.cs" + +[[extensions]] +name = "Or" +returns = "Expression>" +sig = "Expression> Or(this Expression> first, Expression> second)" +summary = "Combines 2 expressions with an logical OR." +file = "Extensions\\LambdaExtensions.cs" + [[classes]] name = "SubstExpressionVisitor" ns = "FEx.Agnostics.Abstractions.Extensions" base = "ExpressionVisitor" -summary = "Combines 2 expressions with an logical OR." +file = "Extensions\\LambdaExtensions.cs" + +[[methods]] +parent = "SubstExpressionVisitor" +name = "VisitParameter" +sig = "Expression VisitParameter(ParameterExpression node)" +returns = "Expression" file = "Extensions\\LambdaExtensions.cs" [[classes]] @@ -798,59 +1753,217 @@ static = true [[extensions]] name = "IsNullOrEmpty" +returns = "bool" sig = "bool IsNullOrEmpty(this object data)" +file = "Extensions\\ObjectExtensions.cs" + +[[extensions]] +name = "ReferenceIsNotNull" returns = "bool" +sig = "bool ReferenceIsNotNull(this T value)" +summary = "Indicates that the specified reference is not a null reference" file = "Extensions\\ObjectExtensions.cs" [[extensions]] -name = "GetTypeInstanceDescription" -sig = "string GetTypeInstanceDescription(this object value)" -returns = "string" -summary = "Gets the value of objects property by its name." +name = "IfNotNull" +returns = "void" +sig = "void IfNotNull(this T value, Action action)" +summary = "Execute a action if T Not null." file = "Extensions\\ObjectExtensions.cs" -[[classes]] -name = "SemaphoreSlimExtensions" -ns = "FEx.Agnostics.Abstractions.Extensions" -file = "Extensions\\SemaphoreSlimExtensions.cs" -static = true +[[extensions]] +name = "IfNotNull" +returns = "void" +sig = "void IfNotNull(this T value, Action action)" +summary = "Execute an action if T Not null." +file = "Extensions\\ObjectExtensions.cs" [[extensions]] -name = "SafeRelease" -sig = "int SafeRelease(this SemaphoreSlim semaphore, int releaseCount = 1)" -returns = "int" -summary = "Exits the a specified number of times." -file = "Extensions\\SemaphoreSlimExtensions.cs" +name = "IfNotNull" +returns = "TOut" +sig = "TOut IfNotNull(this T value, Func fn)" +summary = "Execute a func if T Not null." +file = "Extensions\\ObjectExtensions.cs" -[[classes]] -name = "StreamExtensions" -ns = "FEx.Agnostics.Abstractions.Extensions" -file = "Extensions\\StreamExtensions.cs" -static = true +[[extensions]] +name = "IfNull" +returns = "void" +sig = "void IfNull(this T value, Action action)" +summary = "Execute an action if T isnull." +file = "Extensions\\ObjectExtensions.cs" [[extensions]] -name = "CopyStreamToStream" -sig = "void CopyStreamToStream(this Stream sourceStream, - Stream destStream, - Action progressMaximumSet = null, - Action progressValueSet = null, - long? length = null)" +name = "IfNull" returns = "void" -file = "Extensions\\StreamExtensions.cs" +sig = "void IfNull(this T value, Action action)" +summary = "Execute a action if T isnull." +file = "Extensions\\ObjectExtensions.cs" [[extensions]] -name = "CopyToMemoryStream" -sig = "MemoryStream CopyToMemoryStream(this Stream streamToCopy, bool disposeSource = false)" -returns = "MemoryStream" -file = "Extensions\\StreamExtensions.cs" +name = "TryDispose" +returns = "void" +sig = "void TryDispose(this T value)" +summary = "Try to Dispose the current object." +file = "Extensions\\ObjectExtensions.cs" [[extensions]] -name = "ComputeMd5Hash" -sig = "string ComputeMd5Hash(this Stream data, - bool removeDashes = true, - bool toLower = true, - bool asBase64String = false)" +name = "ReferenceIsNull" +returns = "bool" +sig = "bool ReferenceIsNull(this T value)" +summary = "Indicates that the specified reference is a null reference" +file = "Extensions\\ObjectExtensions.cs" + +[[extensions]] +name = "With" +returns = "TInput" +sig = "TInput With(this TInput value, params Action[] actions)" +summary = "Execute a Action with TInput as parameter." +file = "Extensions\\ObjectExtensions.cs" + +[[extensions]] +name = "GetPropertyValueByName" +returns = "T" +sig = "T GetPropertyValueByName(this object obj, string name, object[] index = null)" +summary = "Gets the value of objects property by its name." +file = "Extensions\\ObjectExtensions.cs" + +[[extensions]] +name = "GetObject" +returns = "T" +sig = "T GetObject(this object value)" +file = "Extensions\\ObjectExtensions.cs" + +[[extensions]] +name = "GetTypeInstanceDescription" +returns = "string" +sig = "string GetTypeInstanceDescription(this object value)" +file = "Extensions\\ObjectExtensions.cs" + +[[extensions]] +name = "IsBetween" +returns = "bool" +sig = "bool IsBetween(this T item, T start, T end, bool inclusive = false)" +file = "Extensions\\ObjectExtensions.cs" + +[[extensions]] +name = "IsIn" +returns = "bool" +sig = "bool IsIn(this T item, params T[] items)" +summary = "Determines whether the specified instance is in given instances set." +file = "Extensions\\ObjectExtensions.cs" + +[[extensions]] +name = "IsIn" +returns = "bool" +sig = "bool IsIn(this T item, IEnumerable items)" +file = "Extensions\\ObjectExtensions.cs" + +[[extensions]] +name = "IsNotIn" +returns = "bool" +sig = "bool IsNotIn(this T item, params T[] items)" +file = "Extensions\\ObjectExtensions.cs" + +[[extensions]] +name = "IsNotIn" +returns = "bool" +sig = "bool IsNotIn(this T item, IEnumerable items)" +file = "Extensions\\ObjectExtensions.cs" + +[[extensions]] +name = "Yield" +returns = "IEnumerable" +sig = "IEnumerable Yield(this T item)" +summary = "Wraps this object instance into an IEnumerable{T} consisting of a single item." +file = "Extensions\\ObjectExtensions.cs" + +[[methods]] +parent = "ObjectExtensions" +name = "IsEqual" +sig = "static bool IsEqual(ref T field, T value)" +returns = "bool" +file = "Extensions\\ObjectExtensions.cs" +static = true + +[[methods]] +parent = "ObjectExtensions" +name = "IsNotEqual" +sig = "static bool IsNotEqual(ref T field, T value)" +returns = "bool" +file = "Extensions\\ObjectExtensions.cs" +static = true + +[[extensions]] +name = "SetObjectProperty" +returns = "bool" +sig = "bool SetObjectProperty(this TSender sender, ref T backingField, T newValue, Action onPropertyChanged, [CallerMemberName] string propertyName = null)" +file = "Extensions\\ObjectExtensions.cs" + +[[extensions]] +name = "SetProperty" +returns = "bool" +sig = "bool SetProperty(this TSender _, ref TRet backingField, TRet newValue, Action onPropertyChanged = null, [CallerMemberName] string propertyName = null)" +file = "Extensions\\ObjectExtensions.cs" + +[[classes]] +name = "SemaphoreSlimExtensions" +ns = "FEx.Agnostics.Abstractions.Extensions" +file = "Extensions\\SemaphoreSlimExtensions.cs" +static = true + +[[extensions]] +name = "SafeRelease" +returns = "int" +sig = "int SafeRelease(this SemaphoreSlim semaphore, int releaseCount = 1)" +summary = "Exits the a specified number of times." +file = "Extensions\\SemaphoreSlimExtensions.cs" + +[[classes]] +name = "StreamExtensions" +ns = "FEx.Agnostics.Abstractions.Extensions" +file = "Extensions\\StreamExtensions.cs" +static = true + +[[extensions]] +name = "CopyStreamToStreamAsync" +returns = "Task" +sig = "Task CopyStreamToStreamAsync(this Stream sourceStream, Stream destStream, Action progressMaximumSet = null, Action progressValueSet = null, long? length = null, CancellationToken cancellationToken = default)" +file = "Extensions\\StreamExtensions.cs" + +[[extensions]] +name = "CopyStreamToStream" +returns = "void" +sig = "void CopyStreamToStream(this Stream sourceStream, Stream destStream, Action progressMaximumSet = null, Action progressValueSet = null, long? length = null)" +file = "Extensions\\StreamExtensions.cs" + +[[extensions]] +name = "ReadFullyAsync" +returns = "Task" +sig = "Task ReadFullyAsync(this Stream input)" +file = "Extensions\\StreamExtensions.cs" + +[[extensions]] +name = "CopyToMemoryStreamAsync" +returns = "Task" +sig = "Task CopyToMemoryStreamAsync(this Stream streamToCopy, bool disposeSource = false, CancellationToken cancellationToken = default)" +file = "Extensions\\StreamExtensions.cs" + +[[extensions]] +name = "CopyToMemoryStream" +returns = "MemoryStream" +sig = "MemoryStream CopyToMemoryStream(this Stream streamToCopy, bool disposeSource = false)" +file = "Extensions\\StreamExtensions.cs" + +[[extensions]] +name = "CopyToStreamAsync" +returns = "Task" +sig = "Task CopyToStreamAsync(this Stream streamToCopy, CancellationToken cancellationToken = default)" +file = "Extensions\\StreamExtensions.cs" + +[[extensions]] +name = "ComputeMd5Hash" returns = "string" +sig = "string ComputeMd5Hash(this Stream data, bool removeDashes = true, bool toLower = true, bool asBase64String = false)" file = "Extensions\\StreamExtensions.cs" [[classes]] @@ -860,529 +1973,663 @@ summary = "String extensions class - comprehensive utilities for string manipula file = "Extensions\\StringExtensions.cs" static = true -[[enums]] -name = "WildCardPosition" -ns = "FEx.Agnostics.Abstractions.Extensions" -summary = "Wild card position." +[[properties]] +parent = "StringExtensions" +name = "WordRegex" +sig = "static Regex WordRegex { get; }" +returns = "Regex" +file = "Extensions\\StringExtensions.cs" +static = true + +[[properties]] +parent = "StringExtensions" +name = "LettersRegex" +sig = "static Regex LettersRegex { get; }" +returns = "Regex" +file = "Extensions\\StringExtensions.cs" +static = true + +[[properties]] +parent = "StringExtensions" +name = "LettersAndNumbersRegex" +sig = "static Regex LettersAndNumbersRegex { get; }" +returns = "Regex" +file = "Extensions\\StringExtensions.cs" +static = true + +[[properties]] +parent = "StringExtensions" +name = "LettersNumbersAndUnderscoreRegex" +sig = "static Regex LettersNumbersAndUnderscoreRegex { get; }" +returns = "Regex" file = "Extensions\\StringExtensions.cs" +static = true [[extensions]] name = "ToCamel" -sig = "string ToCamel(this string text)" returns = "string" -summary = "The SQL wild card 'any value'." +sig = "string ToCamel(this string text)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ToNiceString" -sig = "string ToNiceString(this string text)" returns = "string" -summary = "The SQL wild card 'any value'." +sig = "string ToNiceString(this string text)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ToFormattedPhoneNumber" -sig = "string ToFormattedPhoneNumber(this string phoneNumber)" returns = "string" -summary = "The SQL wild card 'any value'." +sig = "string ToFormattedPhoneNumber(this string phoneNumber)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "AppendJoin" -sig = "void AppendJoin(this StringBuilder stringBuilder, IEnumerable collection)" returns = "void" +sig = "void AppendJoin(this StringBuilder stringBuilder, IEnumerable collection)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ComputeMd5Hash" -sig = "string ComputeMd5Hash(this string value)" returns = "string" +sig = "string ComputeMd5Hash(this string value)" summary = "Generate MD5 hash from the specified string" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ContainsAny" -sig = "bool ContainsAny(this string value, IEnumerable toCheck, StringComparison comparisonType)" returns = "bool" +sig = "bool ContainsAny(this string value, IEnumerable toCheck, StringComparison comparisonType)" summary = "Returns a value indicating whether any of a set of specified substrings occurs within this string." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "IndexOf" -sig = "int IndexOf(this string value, params string[] matchCandidates)" returns = "int" +sig = "int IndexOf(this string value, params string[] matchCandidates)" summary = "Searches for the index of the first occurrence of the specified strings in the input string." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "FromString" -sig = "decimal FromString(this string value)" returns = "decimal" +sig = "decimal FromString(this string value)" summary = "Converts string to decimal value and replace symbols with CurrentCulture NumberDecimalSeparator" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ToUri" -sig = "Uri ToUri(this string source, Uri baseUri = null, UriKind kind = UriKind.Absolute)" returns = "Uri" -summary = "Converts string to decimal value and replace symbols with CurrentCulture NumberDecimalSeparator" +sig = "Uri ToUri(this string source, Uri baseUri = null, UriKind kind = UriKind.Absolute)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ValidateCheckDigit" -sig = "bool ValidateCheckDigit(this string value)" returns = "bool" +sig = "bool ValidateCheckDigit(this string value)" summary = "Modulus 10 algorithm created by Hans Peter Luhn. Uses a weight of 2 which is applied to every odd position digit." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ToProperCase" -sig = "string ToProperCase(this string input)" returns = "string" +sig = "string ToProperCase(this string input)" summary = "Converts a string to proper case, handling special cases for names, Scottish prefixes, and Roman numerals." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "IsAllUpperOrAllLower" -sig = "bool IsAllUpperOrAllLower(this string input)" returns = "bool" -summary = "Converts a string to proper case, handling special cases for names, Scottish prefixes, and Roman numerals." +sig = "bool IsAllUpperOrAllLower(this string input)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "CompareOrdinalIgnoreCase" -sig = "bool CompareOrdinalIgnoreCase(this string source, string value)" returns = "bool" -summary = "Converts a string to proper case, handling special cases for names, Scottish prefixes, and Roman numerals." +sig = "bool CompareOrdinalIgnoreCase(this string source, string value)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ContainsOrdinalIgnoreCase" -sig = "bool ContainsOrdinalIgnoreCase(this string str, string other)" returns = "bool" +sig = "bool ContainsOrdinalIgnoreCase(this string str, string other)" summary = "Indicates whether a string contains another string under comparison." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "IsEqual" -sig = "bool IsEqual(this string source, - string value, - StringComparison comparisonType = StringComparison.OrdinalIgnoreCase)" returns = "bool" +sig = "bool IsEqual(this string source, string value, StringComparison comparisonType = StringComparison.OrdinalIgnoreCase)" summary = "Compare 2 strings, ignoring case." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "IsNotEqual" -sig = "bool IsNotEqual(this string source, - string value, - StringComparison comparisonType = StringComparison.OrdinalIgnoreCase)" returns = "bool" +sig = "bool IsNotEqual(this string source, string value, StringComparison comparisonType = StringComparison.OrdinalIgnoreCase)" summary = "Determines whether string is not equal to the specified value." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "IsNullOrEmptyString" -sig = "bool IsNullOrEmptyString(this string value)" returns = "bool" +sig = "bool IsNullOrEmptyString(this string value)" summary = "Gets a value indicating if the string is Null or Empty." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "IsNotNullOrEmptyString" -sig = "bool IsNotNullOrEmptyString(this string value)" returns = "bool" +sig = "bool IsNotNullOrEmptyString(this string value)" summary = "Gets a value indicating if the string is NOT Null or Empty." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "Remove" -sig = "string Remove(this string text, params char[] chars)" returns = "string" +sig = "string Remove(this string text, params char[] chars)" summary = "Removes the specified chars from current string." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "Remove" -sig = "string Remove(this string text, params string[] strings)" returns = "string" +sig = "string Remove(this string text, params string[] strings)" summary = "Removes the specified strings from current string." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ToDebug" -sig = "string ToDebug(this string value)" returns = "string" +sig = "string ToDebug(this string value)" summary = "Writes value to the debug output." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ToTrace" -sig = "string ToTrace(this string value)" returns = "string" +sig = "string ToTrace(this string value)" summary = "Writes value to the trace output." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "HasNoWildCards" -sig = "bool HasNoWildCards(this string value)" returns = "bool" +sig = "bool HasNoWildCards(this string value)" summary = "Determines whether given string has no wild cards." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "HasNoSqlWildCards" -sig = "bool HasNoSqlWildCards(this string value)" returns = "bool" +sig = "bool HasNoSqlWildCards(this string value)" summary = "Determines whether given string has no SQL wild cards." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ReplaceStandardWildCardsBySql" -sig = "string ReplaceStandardWildCardsBySql(this string value)" returns = "string" +sig = "string ReplaceStandardWildCardsBySql(this string value)" summary = "Replaces the standard wild cards by SQL ones." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "EscapeSqlWildCards" -sig = "string EscapeSqlWildCards(this string value)" returns = "string" +sig = "string EscapeSqlWildCards(this string value)" summary = "Escape SQL wild cards characters." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "Split" -sig = "IList Split(this string value, string splitValue, int stringLength)" returns = "IList" +sig = "IList Split(this string value, string splitValue, int stringLength)" summary = "Splits the specified string into parts." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ToStream" -sig = "Stream ToStream(this string str)" returns = "Stream" +sig = "Stream ToStream(this string str)" summary = "Converts the specified string to stream." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "DivideByCapital" -sig = "string DivideByCapital(this string value)" returns = "string" +sig = "string DivideByCapital(this string value)" summary = "Divides the by capital letter." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "IsNullOrWhiteSpace" -sig = "bool IsNullOrWhiteSpace(this string value)" returns = "bool" +sig = "bool IsNullOrWhiteSpace(this string value)" summary = "Determines whether the specified string is null or white space." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "IsNotNullOrWhiteSpace" -sig = "bool IsNotNullOrWhiteSpace(this string value)" returns = "bool" +sig = "bool IsNotNullOrWhiteSpace(this string value)" summary = "Determines whether the specified string is not null or white space." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "IsNotNullOrEmptyOrWhiteSpace" -sig = "bool IsNotNullOrEmptyOrWhiteSpace(this string value)" returns = "bool" -summary = "Determines whether the specified string is not null or white space." +sig = "bool IsNotNullOrEmptyOrWhiteSpace(this string value)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "IsNullOrEmptyOrWhiteSpace" -sig = "bool IsNullOrEmptyOrWhiteSpace(this string value)" returns = "bool" -summary = "Determines whether the specified string is not null or white space." +sig = "bool IsNullOrEmptyOrWhiteSpace(this string value)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "MatchesRegex" -sig = "bool MatchesRegex(this string text, string regexPattern)" returns = "bool" -summary = "Determines whether the specified string is not null or white space." +sig = "bool MatchesRegex(this string text, string regexPattern)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "MatchesRegex" -sig = "bool MatchesRegex(this string text, Regex regex)" returns = "bool" -summary = "Determines whether the specified string is not null or white space." +sig = "bool MatchesRegex(this string text, Regex regex)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "IsAWord" -sig = "bool IsAWord(this string text)" returns = "bool" -summary = "Determines whether the specified string is not null or white space." +sig = "bool IsAWord(this string text)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ContainsOnlyLetters" -sig = "bool ContainsOnlyLetters(this string text)" returns = "bool" -summary = "Determines whether the specified string is not null or white space." +sig = "bool ContainsOnlyLetters(this string text)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ContainsOnlyLettersAndNumbers" -sig = "bool ContainsOnlyLettersAndNumbers(this string text)" returns = "bool" -summary = "Determines whether the specified string is not null or white space." +sig = "bool ContainsOnlyLettersAndNumbers(this string text)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ContainsOnlyLettersNumbersAndUnderscore" -sig = "bool ContainsOnlyLettersNumbersAndUnderscore(this string text)" returns = "bool" -summary = "Determines whether the specified string is not null or white space." +sig = "bool ContainsOnlyLettersNumbersAndUnderscore(this string text)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "Contains" -sig = "bool Contains(this string source, string toCheck, StringComparison comp)" returns = "bool" +sig = "bool Contains(this string source, string toCheck, StringComparison comp)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "GetPathParts" -sig = "IEnumerable GetPathParts(this string path)" returns = "IEnumerable" +sig = "IEnumerable GetPathParts(this string path)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "FirstCharToUpper" -sig = "string FirstCharToUpper(this string input)" returns = "string" +sig = "string FirstCharToUpper(this string input)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "FirstCharToLower" -sig = "string FirstCharToLower(this string input)" returns = "string" +sig = "string FirstCharToLower(this string input)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "Left" -sig = "string Left(this string str, int length, bool trim = false)" returns = "string" +sig = "string Left(this string str, int length, bool trim = false)" summary = "Returns a string containing a specified number of characters from the left side of a string." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "Mid" -sig = "string Mid(this string str, int start, bool trim = false)" returns = "string" +sig = "string Mid(this string str, int start, bool trim = false)" summary = "Returns a string that contains all the characters starting from a specified position in a string." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "Mid" -sig = "string Mid(this string str, int start, int length, bool trim = false)" returns = "string" +sig = "string Mid(this string str, int start, int length, bool trim = false)" summary = "Returns a string that contains a specified number of characters starting from a specified position in a string." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "Right" -sig = "string Right(this string str, int length, bool trim = false)" returns = "string" +sig = "string Right(this string str, int length, bool trim = false)" summary = "Returns a string containing a specified number of characters from the right side of a string." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "Length" -sig = "int Length(this string value, bool trim = true)" returns = "int" -summary = "Returns a string containing a specified number of characters from the right side of a string." +sig = "int Length(this string value, bool trim = true)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ToBase64" -sig = "string ToBase64(this string str, Encoding enc = null)" returns = "string" -summary = "Returns a string containing a specified number of characters from the right side of a string." +sig = "string ToBase64(this string str, Encoding enc = null)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "FromBase64" -sig = "string FromBase64(this string base64EncodedData, Encoding enc = null)" returns = "string" +sig = "string FromBase64(this string base64EncodedData, Encoding enc = null)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "CopyTo" -sig = "void CopyTo(this Stream src, Stream dest)" returns = "void" +sig = "void CopyTo(this Stream src, Stream dest)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "Zip" -sig = "string Zip(this string str)" returns = "string" +sig = "string Zip(this string str)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "Unzip" -sig = "string Unzip(this string bytes)" returns = "string" +sig = "string Unzip(this string bytes)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "IsBothNullOrEqual" -sig = "bool IsBothNullOrEqual(this string source, - string value, - StringComparison comparisonType = StringComparison.Ordinal)" returns = "bool" +sig = "bool IsBothNullOrEqual(this string source, string value, StringComparison comparisonType = StringComparison.Ordinal)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ByteArrayToString" -sig = "string ByteArrayToString(this byte[] ba)" returns = "string" +sig = "string ByteArrayToString(this byte[] ba)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "StringToByteArray" -sig = "byte[] StringToByteArray(this string hex)" returns = "byte[]" +sig = "byte[] StringToByteArray(this string hex)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "GetGuidString" -sig = "string GetGuidString(this Guid? guid)" returns = "string" +sig = "string GetGuidString(this Guid? guid)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "GetGuidString" -sig = "string GetGuidString(this Guid guid)" returns = "string" +sig = "string GetGuidString(this Guid guid)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "NormalizeLineBreaks" -sig = "string NormalizeLineBreaks(this string input)" returns = "string" +sig = "string NormalizeLineBreaks(this string input)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ComputeSha256Hash" -sig = "string ComputeSha256Hash(this string rawData)" returns = "string" +sig = "string ComputeSha256Hash(this string rawData)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "TrimLength" -sig = "string TrimLength(this string value, int length, bool trim = false)" returns = "string" +sig = "string TrimLength(this string value, int length, bool trim = false)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "GenerateMd5OfString" -sig = "string GenerateMd5OfString(this string value)" returns = "string" +sig = "string GenerateMd5OfString(this string value)" summary = "Generates the md5 of string." file = "Extensions\\StringExtensions.cs" [[extensions]] name = "RemoveDiacritics" -sig = "string RemoveDiacritics(this string text)" returns = "string" -summary = "Generates the md5 of string." +sig = "string RemoveDiacritics(this string text)" file = "Extensions\\StringExtensions.cs" [[extensions]] name = "ToInt" -sig = "int ToInt(this string value)" returns = "int" +sig = "int ToInt(this string value)" summary = "Converts string to int, returns -1 if conversion fails" file = "Extensions\\StringExtensions.cs" -[[classes]] -name = "TaskExtensions" +[[enums]] +name = "WildCardPosition" +ns = "FEx.Agnostics.Abstractions.Extensions" +summary = "Wild card position." +file = "Extensions\\StringExtensions.cs" + +[[classes]] +name = "TaskExtensions" ns = "FEx.Agnostics.Abstractions.Extensions" file = "Extensions\\TaskExtensions.cs" static = true +[[extensions]] +name = "WhenAllAsync" +returns = "Task" +sig = "Task WhenAllAsync(this IEnumerable tasks, AsyncMode mode = AsyncMode.Default, AsyncOptions options = AsyncOptions.ImmediateStart, CancellationToken cancellationToken = default)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "WhenAllAsync" +returns = "Task" +sig = "Task WhenAllAsync(this IEnumerable> tasks, AsyncMode mode = AsyncMode.Default, AsyncOptions options = AsyncOptions.ImmediateStart, CancellationToken cancellationToken = default)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "WhenAllTasksAsync" +returns = "Task" +sig = "Task WhenAllTasksAsync(this IEnumerable> tasks, AsyncMode mode = AsyncMode.Default, AsyncOptions options = AsyncOptions.ImmediateStart)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "WhenAllTasksAsync" +returns = "Task" +sig = "Task WhenAllTasksAsync(this IEnumerable>> tasks, AsyncMode mode = AsyncMode.Default, AsyncOptions options = AsyncOptions.ImmediateStart)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "WithWhenAllAsync" +returns = "Task" +sig = "Task WithWhenAllAsync(this IEnumerable values, Action asyncAction, AsyncMode mode = AsyncMode.Default, AsyncOptions options = AsyncOptions.ImmediateStart, CancellationToken cancellationToken = default)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "WithWhenAllAsync" +returns = "Task" +sig = "Task WithWhenAllAsync(this IEnumerable values, Func asyncAction, AsyncMode mode = AsyncMode.Default, AsyncOptions options = AsyncOptions.ImmediateStart, CancellationToken cancellationToken = default)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "WithWhenAllTasksAsync" +returns = "Task" +sig = "Task WithWhenAllTasksAsync(this IEnumerable values, Func asyncAction, AsyncMode mode = AsyncMode.Default, AsyncOptions options = AsyncOptions.ImmediateStart)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "WithWhenAllTasksAsync" +returns = "Task" +sig = "Task WithWhenAllTasksAsync(this IEnumerable values, Func> asyncAction, AsyncMode mode = AsyncMode.Default, AsyncOptions options = AsyncOptions.ImmediateStart)" +file = "Extensions\\TaskExtensions.cs" + [[extensions]] name = "FireOnMainThreadAndForget" -sig = "ITaskWrapper FireOnMainThreadAndForget(this IAsyncHelper asyncHelper, - Action action, - CancellationToken cancellationToken = default)" returns = "ITaskWrapper" +sig = "ITaskWrapper FireOnMainThreadAndForget(this IAsyncHelper asyncHelper, Action action, CancellationToken cancellationToken = default)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "FireOnMainThreadAndForget" +returns = "ITaskWrapper" +sig = "ITaskWrapper FireOnMainThreadAndForget(this IAsyncHelper asyncHelper, Func func, CancellationToken cancellationToken = default)" file = "Extensions\\TaskExtensions.cs" [[extensions]] name = "FireTaskOnMainThreadAndForget" -sig = "ITaskWrapper FireTaskOnMainThreadAndForget(this IAsyncHelper asyncHelper, Func task)" returns = "ITaskWrapper" +sig = "ITaskWrapper FireTaskOnMainThreadAndForget(this IAsyncHelper asyncHelper, Func task)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "FireTaskOnMainThreadAndForget" +returns = "ITaskWrapper" +sig = "ITaskWrapper FireTaskOnMainThreadAndForget(this IAsyncHelper asyncHelper, Func> task)" file = "Extensions\\TaskExtensions.cs" [[extensions]] name = "FireTasksOnMainThreadAndForget" -sig = "IReadOnlyList FireTasksOnMainThreadAndForget(this IAsyncHelper asyncHelper, - IEnumerable> tasks)" returns = "IReadOnlyList" +sig = "IReadOnlyList FireTasksOnMainThreadAndForget(this IAsyncHelper asyncHelper, IEnumerable> tasks)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "FireTasksOnMainThreadAndForget" +returns = "IReadOnlyList>" +sig = "IReadOnlyList> FireTasksOnMainThreadAndForget(this IAsyncHelper asyncHelper, IEnumerable>> tasks)" file = "Extensions\\TaskExtensions.cs" [[extensions]] name = "FireOnThreadPoolAndForget" -sig = "ITaskWrapper FireOnThreadPoolAndForget(this IAsyncHelper asyncHelper, - Action action, - CancellationToken cancellationToken = default)" returns = "ITaskWrapper" +sig = "ITaskWrapper FireOnThreadPoolAndForget(this IAsyncHelper asyncHelper, Action action, CancellationToken cancellationToken = default)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "FireOnThreadPoolAndForget" +returns = "ITaskWrapper" +sig = "ITaskWrapper FireOnThreadPoolAndForget(this IAsyncHelper asyncHelper, Func func, CancellationToken cancellationToken = default)" file = "Extensions\\TaskExtensions.cs" [[extensions]] name = "FireTaskOnThreadPoolAndForget" -sig = "ITaskWrapper FireTaskOnThreadPoolAndForget(this IAsyncHelper asyncHelper, Func task)" returns = "ITaskWrapper" +sig = "ITaskWrapper FireTaskOnThreadPoolAndForget(this IAsyncHelper asyncHelper, Func task)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "FireTaskOnThreadPoolAndForget" +returns = "ITaskWrapper" +sig = "ITaskWrapper FireTaskOnThreadPoolAndForget(this IAsyncHelper asyncHelper, Func> task)" file = "Extensions\\TaskExtensions.cs" [[extensions]] name = "FireTasksOnThreadPoolAndForget" -sig = "IReadOnlyList FireTasksOnThreadPoolAndForget(this IAsyncHelper asyncHelper, - IEnumerable> tasks)" returns = "IReadOnlyList" +sig = "IReadOnlyList FireTasksOnThreadPoolAndForget(this IAsyncHelper asyncHelper, IEnumerable> tasks)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "FireTasksOnThreadPoolAndForget" +returns = "IReadOnlyList>" +sig = "IReadOnlyList> FireTasksOnThreadPoolAndForget(this IAsyncHelper asyncHelper, IEnumerable>> tasks)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "WaitForTaskToStartAsync" +returns = "Task" +sig = "Task WaitForTaskToStartAsync(this Task task)" +summary = "Waits for task to start." +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "WaitForTaskToEndAsync" +returns = "Task" +sig = "Task WaitForTaskToEndAsync(this Task task)" file = "Extensions\\TaskExtensions.cs" [[extensions]] name = "IsRunning" -sig = "bool IsRunning(this Task task)" returns = "bool" -summary = "Waits for task to start." +sig = "bool IsRunning(this Task task)" file = "Extensions\\TaskExtensions.cs" [[extensions]] name = "IsNotStarted" -sig = "bool IsNotStarted(this Task task)" returns = "bool" -summary = "Waits for task to start." +sig = "bool IsNotStarted(this Task task)" file = "Extensions\\TaskExtensions.cs" [[extensions]] name = "IsFinished" -sig = "bool IsFinished(this Task task)" returns = "bool" -summary = "Waits for task to start." +sig = "bool IsFinished(this Task task)" file = "Extensions\\TaskExtensions.cs" [[extensions]] name = "IsFailed" -sig = "bool IsFailed(this Task task)" returns = "bool" -summary = "Waits for task to start." +sig = "bool IsFailed(this Task task)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "WhenAllAsync" +returns = "Task" +sig = "Task WhenAllAsync(this IEnumerable tasks)" +summary = "Creates a task that will complete when all the supplied tasks have completed." +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "WhenAllAsync" +returns = "Task" +sig = "Task WhenAllAsync(this IEnumerable> tasks)" +summary = "Creates a task that will complete when all the supplied tasks have completed." file = "Extensions\\TaskExtensions.cs" [[extensions]] name = "Wrap" -sig = "object Wrap(this Action action)" returns = "object" +sig = "object Wrap(this Action action)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "WrapTask" +returns = "Func>" +sig = "Func> WrapTask(this Func taskFunc)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "WrapTask" +returns = "Func>" +sig = "Func> WrapTask(this Func taskFunc, T arg)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "WrapTaskAsync" +returns = "Task" +sig = "Task WrapTaskAsync(this Func taskFunc, T arg)" +file = "Extensions\\TaskExtensions.cs" + +[[extensions]] +name = "WrapTaskAsync" +returns = "Task" +sig = "Task WrapTaskAsync(this Func taskFunc)" file = "Extensions\\TaskExtensions.cs" [[classes]] @@ -1394,92 +2641,102 @@ static = true [[extensions]] name = "IsMidnight" -sig = "bool IsMidnight(this TimeSpan value)" returns = "bool" +sig = "bool IsMidnight(this TimeSpan value)" summary = "Gets a value indicating if the time is midnight (00:00:00)." file = "Extensions\\TimeSpanExtensions.cs" [[extensions]] name = "Days" -sig = "TimeSpan Days(this int number)" returns = "TimeSpan" +sig = "TimeSpan Days(this int number)" summary = "Gets a TimeSpan for n number of Days." file = "Extensions\\TimeSpanExtensions.cs" [[extensions]] name = "Hours" -sig = "TimeSpan Hours(this int number)" returns = "TimeSpan" +sig = "TimeSpan Hours(this int number)" summary = "Gets a TimeSpan for n number of Hours." file = "Extensions\\TimeSpanExtensions.cs" [[extensions]] name = "Minutes" -sig = "TimeSpan Minutes(this int number)" returns = "TimeSpan" +sig = "TimeSpan Minutes(this int number)" summary = "Gets a TimeSpan for n number of Minutes." file = "Extensions\\TimeSpanExtensions.cs" [[extensions]] name = "Seconds" -sig = "TimeSpan Seconds(this int number)" returns = "TimeSpan" +sig = "TimeSpan Seconds(this int number)" summary = "Gets a TimeSpan for n number of Seconds." file = "Extensions\\TimeSpanExtensions.cs" +[[extensions]] +name = "ToUniversalTime" +returns = "TimeSpan?" +sig = "TimeSpan? ToUniversalTime(this TimeSpan? value)" +summary = "Converts to the universal time." +file = "Extensions\\TimeSpanExtensions.cs" + +[[extensions]] +name = "ToLocalTime" +returns = "TimeSpan?" +sig = "TimeSpan? ToLocalTime(this TimeSpan? value)" +summary = "Converts to the local time." +file = "Extensions\\TimeSpanExtensions.cs" + [[extensions]] name = "GetTime" -sig = "string GetTime(this Stopwatch stopwatch)" returns = "string" +sig = "string GetTime(this Stopwatch stopwatch)" summary = "Gets the time from ." file = "Extensions\\TimeSpanExtensions.cs" [[extensions]] name = "GetTime" -sig = "string GetTime(this long milliseconds)" returns = "string" +sig = "string GetTime(this long milliseconds)" summary = "Gets the time." file = "Extensions\\TimeSpanExtensions.cs" [[extensions]] name = "GetTime" -sig = "string GetTime(this double milliseconds)" returns = "string" -summary = "Gets the time." +sig = "string GetTime(this double milliseconds)" file = "Extensions\\TimeSpanExtensions.cs" [[extensions]] name = "GetTime" -sig = "string GetTime(this TimeSpan timespan)" returns = "string" +sig = "string GetTime(this TimeSpan timespan)" summary = "Gets the time from ." file = "Extensions\\TimeSpanExtensions.cs" [[extensions]] name = "GetTime" -sig = "string GetTime(this TimeSpan timespan, int decimals)" returns = "string" -summary = "Gets the time from ." +sig = "string GetTime(this TimeSpan timespan, int decimals)" file = "Extensions\\TimeSpanExtensions.cs" [[extensions]] name = "RoundDown" -sig = "double RoundDown(this double i, double decimalPlaces)" returns = "double" -summary = "Gets the time from ." +sig = "double RoundDown(this double i, double decimalPlaces)" file = "Extensions\\TimeSpanExtensions.cs" [[extensions]] name = "RoundUp" -sig = "TimeSpan RoundUp(this TimeSpan timeSpan, int roundToMinutes)" returns = "TimeSpan" -summary = "Gets the time from ." +sig = "TimeSpan RoundUp(this TimeSpan timeSpan, int roundToMinutes)" file = "Extensions\\TimeSpanExtensions.cs" [[extensions]] name = "IsAm" -sig = "bool IsAm(this TimeSpan timeSpan)" returns = "bool" +sig = "bool IsAm(this TimeSpan timeSpan)" file = "Extensions\\TimeSpanExtensions.cs" [[classes]] @@ -1490,36 +2747,53 @@ static = true [[extensions]] name = "GetImplementedInterfaces" -sig = "IEnumerable GetImplementedInterfaces(this Type interfaceType)" returns = "IEnumerable" +sig = "IEnumerable GetImplementedInterfaces(this Type interfaceType)" summary = "Gets the implemented interfaces." file = "Extensions\\TypeExtensions.cs" [[extensions]] name = "GetImplementedClasses" -sig = "IEnumerable GetImplementedClasses(this Type baseType)" returns = "IEnumerable" +sig = "IEnumerable GetImplementedClasses(this Type baseType)" summary = "Gets the implemented classes." file = "Extensions\\TypeExtensions.cs" [[extensions]] name = "GetBaseTypes" -sig = "List GetBaseTypes(this Type baseType, List baseTypes = null)" returns = "List" +sig = "List GetBaseTypes(this Type baseType, List baseTypes = null)" summary = "Gets the base types." file = "Extensions\\TypeExtensions.cs" [[extensions]] name = "GetTypeDescription" -sig = "string GetTypeDescription(this Type value)" returns = "string" -summary = "Gets the base types." +sig = "string GetTypeDescription(this Type value)" +file = "Extensions\\TypeExtensions.cs" + +[[extensions]] +name = "GetTypeCustomAttribute" +returns = "TAttributeType[]" +sig = "TAttributeType[] GetTypeCustomAttribute(this Type value)" +file = "Extensions\\TypeExtensions.cs" + +[[extensions]] +name = "IsGenericTypeOf" +returns = "bool" +sig = "bool IsGenericTypeOf( #if NET9_0_OR_GREATER [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.Interfaces)] #endif this Type t, Type genericDefinition)" +file = "Extensions\\TypeExtensions.cs" + +[[extensions]] +name = "IsGenericTypeOf" +returns = "bool" +sig = "bool IsGenericTypeOf( #if NET9_0_OR_GREATER [DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.Interfaces)] #endif this Type t, Type genericDefinition, out Type[] genericParameters)" file = "Extensions\\TypeExtensions.cs" [[extensions]] name = "IsOrInherits" -sig = "bool IsOrInherits(this Type type, Type typeToCompare)" returns = "bool" +sig = "bool IsOrInherits(this Type type, Type typeToCompare)" file = "Extensions\\TypeExtensions.cs" [[classes]] @@ -1530,14 +2804,14 @@ static = true [[extensions]] name = "FirstIsOtherThanSecond" -sig = "bool FirstIsOtherThanSecond(this Version first, Version second)" returns = "bool" +sig = "bool FirstIsOtherThanSecond(this Version first, Version second)" file = "Extensions\\VersionExtensions.cs" [[extensions]] name = "FirstIsHigherThanSecond" -sig = "bool FirstIsHigherThanSecond(this Version first, Version second)" returns = "bool" +sig = "bool FirstIsHigherThanSecond(this Version first, Version second)" file = "Extensions\\VersionExtensions.cs" [[classes]] @@ -1546,6 +2820,24 @@ ns = "FEx.Agnostics.Abstractions.Extensions" file = "Extensions\\WhenResultExtensions.cs" static = true +[[extensions]] +name = "When" +returns = "WhenResult" +sig = "WhenResult When(this T value, Func predicate, TResult result)" +file = "Extensions\\WhenResultExtensions.cs" + +[[extensions]] +name = "When" +returns = "WhenResult" +sig = "WhenResult When(this WhenResult whenResult, Func predicate, TResult result)" +file = "Extensions\\WhenResultExtensions.cs" + +[[extensions]] +name = "Else" +returns = "TResult" +sig = "TResult Else(this WhenResult whenResult, TResult result)" +file = "Extensions\\WhenResultExtensions.cs" + [[classes]] name = "XElementExtensions" ns = "FEx.Agnostics.Abstractions.Extensions" @@ -1554,113 +2846,120 @@ static = true [[extensions]] name = "ToXmlElement" -sig = "IXPathNavigable ToXmlElement(this XNode el)" returns = "IXPathNavigable" +sig = "IXPathNavigable ToXmlElement(this XNode el)" summary = "Convert to a XML element." file = "Extensions\\XElementExtensions.cs" [[extensions]] name = "GetAttributeValue" -sig = "string GetAttributeValue(this XElement element, string attributeName)" returns = "string" +sig = "string GetAttributeValue(this XElement element, string attributeName)" summary = "Gets a attribute value." file = "Extensions\\XElementExtensions.cs" +[[extensions]] +name = "SetValue" +returns = "XAttribute" +sig = "XAttribute SetValue(this XAttribute attribute, T value)" +summary = "Sets the value for an attribute." +file = "Extensions\\XElementExtensions.cs" + [[extensions]] name = "Create" -sig = "XAttribute Create(this XObject attribute, string attributeName)" returns = "XAttribute" +sig = "XAttribute Create(this XObject attribute, string attributeName)" summary = "Creates a attribute." file = "Extensions\\XElementExtensions.cs" [[extensions]] name = "Create" -sig = "XAttribute Create(this XObject attribute, string attributeName, string value)" returns = "XAttribute" +sig = "XAttribute Create(this XObject attribute, string attributeName, string value)" summary = "Creates a attribute." file = "Extensions\\XElementExtensions.cs" [[extensions]] name = "CreateAttribute" -sig = "XContainer CreateAttribute(this XContainer element, string attributeName)" returns = "XContainer" +sig = "XContainer CreateAttribute(this XContainer element, string attributeName)" summary = "Creates a attribute." file = "Extensions\\XElementExtensions.cs" [[extensions]] name = "CreateAttribute" -sig = "XContainer CreateAttribute(this XContainer element, string attributeName, string value)" returns = "XContainer" +sig = "XContainer CreateAttribute(this XContainer element, string attributeName, string value)" summary = "Creates a attribute." file = "Extensions\\XElementExtensions.cs" [[extensions]] name = "GetOrCreateAttribute" -sig = "XAttribute GetOrCreateAttribute(this XElement element, string attributeName)" returns = "XAttribute" +sig = "XAttribute GetOrCreateAttribute(this XElement element, string attributeName)" summary = "Gets a attribute (if the attribute not exist it's created)." file = "Extensions\\XElementExtensions.cs" [[extensions]] name = "GetChildValue" -sig = "string GetChildValue(this XElement element, string childName)" returns = "string" +sig = "string GetChildValue(this XElement element, string childName)" summary = "Gets a value for a child." file = "Extensions\\XElementExtensions.cs" [[extensions]] name = "GetChildValue" -sig = "string GetChildValue(this XElement element, string childName, string nameSpace)" returns = "string" +sig = "string GetChildValue(this XElement element, string childName, string nameSpace)" summary = "Gets the child value." file = "Extensions\\XElementExtensions.cs" [[extensions]] name = "GetChild" -sig = "XElement GetChild(this XElement element, string childName)" returns = "XElement" +sig = "XElement GetChild(this XElement element, string childName)" summary = "Gets the child." file = "Extensions\\XElementExtensions.cs" [[extensions]] name = "GetChild" -sig = "XElement GetChild(this XElement element, string childName, string nameSpace)" returns = "XElement" +sig = "XElement GetChild(this XElement element, string childName, string nameSpace)" summary = "Gets the child." file = "Extensions\\XElementExtensions.cs" [[extensions]] name = "CreateChild" -sig = "XElement CreateChild(this XContainer element, string childName)" returns = "XElement" +sig = "XElement CreateChild(this XContainer element, string childName)" summary = "Creates a child element." file = "Extensions\\XElementExtensions.cs" [[extensions]] name = "CreateChild" -sig = "XElement CreateChild(this XContainer element, string childName, string value)" returns = "XElement" +sig = "XElement CreateChild(this XContainer element, string childName, string value)" summary = "Creates a child element." file = "Extensions\\XElementExtensions.cs" [[extensions]] name = "SetChildValue" -sig = "XElement SetChildValue(this XElement element, string value)" returns = "XElement" +sig = "XElement SetChildValue(this XElement element, string value)" summary = "Sets the value for an element." file = "Extensions\\XElementExtensions.cs" [[extensions]] name = "GetOrCreateChild" -sig = "XElement GetOrCreateChild(this XElement element, string childName)" returns = "XElement" +sig = "XElement GetOrCreateChild(this XElement element, string childName)" summary = "Gets a element (if the element not exist it's created)." file = "Extensions\\XElementExtensions.cs" [[extensions]] name = "GetOrCreateChild" -sig = "XElement GetOrCreateChild(this XElement element, string childName, string value)" returns = "XElement" +sig = "XElement GetOrCreateChild(this XElement element, string childName, string value)" summary = "Gets a element (if the element not exist it's created)." file = "Extensions\\XElementExtensions.cs" @@ -1670,60 +2969,2604 @@ ns = "FEx.Agnostics.Abstractions.Extensions" file = "Extensions\\XmlExtensions.cs" static = true +[[extensions]] +name = "Deserialize" +returns = "T" +sig = "T Deserialize(this XmlSerializer serializer, Stream stream)" +file = "Extensions\\XmlExtensions.cs" + +[[extensions]] +name = "Serialize" +returns = "string" +sig = "string Serialize(this XmlSerializer serializer, T value)" +file = "Extensions\\XmlExtensions.cs" + [[extensions]] name = "Add" -sig = "XmlSchema Add(this XmlSchemaSet xmlSchemaSet, string targetNamespace, Stream schemaStream)" returns = "XmlSchema" +sig = "XmlSchema Add(this XmlSchemaSet xmlSchemaSet, string targetNamespace, Stream schemaStream)" file = "Extensions\\XmlExtensions.cs" [[extensions]] name = "AddManifestResourceSchema" -sig = "XmlSchema AddManifestResourceSchema(this XmlSchemaSet xmlSchemaSet, - Assembly resourceAssembly, - string targetNamespace, - string name)" returns = "XmlSchema" +sig = "XmlSchema AddManifestResourceSchema(this XmlSchemaSet xmlSchemaSet, Assembly resourceAssembly, string targetNamespace, string name)" file = "Extensions\\XmlExtensions.cs" -[[classes]] -name = "ArrayExtensions" -ns = "FEx.Agnostics.Abstractions.Extensions.Collections.Arrays" -file = "Extensions\\Collections\\Arrays\\ArrayExtensions.cs" -static = true +[[extensions]] +name = "ValidateAndDeserialize" +returns = "T" +sig = "T ValidateAndDeserialize(this XmlSerializer serializer, string xml, Func func)" +file = "Extensions\\XmlExtensions.cs" [[extensions]] -name = "WithinIndex" -sig = "bool WithinIndex(this Array source, int index)" -returns = "bool" -summary = "Check if the index is within the array" -file = "Extensions\\Collections\\Arrays\\ArrayExtensions.cs" +name = "ValidateAndDeserialize" +returns = "T" +sig = "T ValidateAndDeserialize(this XmlSerializer serializer, Stream stream, Func func)" +file = "Extensions\\XmlExtensions.cs" [[extensions]] -name = "IndexOf" -sig = "int IndexOf(this Array source, object value)" -returns = "int" -summary = "Indexes the of." -file = "Extensions\\Collections\\Arrays\\ArrayExtensions.cs" +name = "SerializeAndValidate" +returns = "string" +sig = "string SerializeAndValidate(this XmlSerializer serializer, T obj, Func func)" +file = "Extensions\\XmlExtensions.cs" [[classes]] -name = "ReadOnlyDictionaryExtensions" -ns = "FEx.Agnostics.Abstractions.Extensions.Collections.Dictionaries" -summary = "IReadOnlyDictionary extensions class." -file = "Extensions\\Collections\\Dictionaries\\ReadOnlyDictionaryExtensions.cs" -static = true +name = "AggregatedError" +ns = "FEx.Agnostics.Abstractions.Flow" +base = "Error" +file = "Flow\\AggregatedError.cs" -[[classes]] -name = "ListExtensions" -ns = "FEx.Agnostics.Abstractions.Extensions.Collections.Lists" -summary = "Extensions for the IList interface." -file = "Extensions\\Collections\\Lists\\ListExtensions.cs" -static = true +[[properties]] +parent = "AggregatedError" +name = "InnerErrors" +sig = "IReadOnlyCollection InnerErrors { get; }" +returns = "IReadOnlyCollection" +file = "Flow\\AggregatedError.cs" -[[classes]] -name = "EnumerableExtensions" -ns = "FEx.Agnostics.Abstractions.Extensions.Interop" -file = "Extensions\\Interop\\EnumerableExtensions.cs" -static = true +[[ctors]] +parent = "AggregatedError" +sig = "AggregatedError()" +file = "Flow\\AggregatedError.cs" + +[[ctors]] +parent = "AggregatedError" +sig = "AggregatedError(IReadOnlyCollection innerErrors)" +file = "Flow\\AggregatedError.cs" + +[[ctors]] +parent = "AggregatedError" +sig = "AggregatedError(IReadOnlyCollection innerErrors, string message)" +file = "Flow\\AggregatedError.cs" + +[[classes]] +name = "Error" +ns = "FEx.Agnostics.Abstractions.Flow" +base = "IError" +file = "Flow\\Error.cs" + +[[properties]] +parent = "Error" +name = "Message" +sig = "string Message { get; }" +returns = "string" +file = "Flow\\Error.cs" + +[[properties]] +parent = "Error" +name = "RootError" +sig = "IError RootError { get; }" +returns = "IError" +file = "Flow\\Error.cs" + +[[properties]] +parent = "Error" +name = "InnerError" +sig = "IError InnerError { get; }" +returns = "IError" +file = "Flow\\Error.cs" + +[[ctors]] +parent = "Error" +sig = "Error()" +file = "Flow\\Error.cs" + +[[ctors]] +parent = "Error" +sig = "Error(string message)" +file = "Flow\\Error.cs" + +[[ctors]] +parent = "Error" +sig = "Error(IError innerError)" +file = "Flow\\Error.cs" + +[[ctors]] +parent = "Error" +sig = "Error(IError innerError, string message)" +file = "Flow\\Error.cs" + +[[methods]] +parent = "Error" +name = "SetInnerError" +sig = "void SetInnerError(IError innerError)" +returns = "void" +file = "Flow\\Error.cs" + +[[classes]] +name = "Error" +ns = "FEx.Agnostics.Abstractions.Flow" +base = "Error" +file = "Flow\\Error.cs" + +[[properties]] +parent = "Error" +name = "Status" +sig = "TErrorStatus Status { get; }" +returns = "TErrorStatus" +file = "Flow\\Error.cs" + +[[ctors]] +parent = "Error" +sig = "Error(TErrorStatus status)" +file = "Flow\\Error.cs" + +[[ctors]] +parent = "Error" +sig = "Error(TErrorStatus status, string message)" +file = "Flow\\Error.cs" + +[[ctors]] +parent = "Error" +sig = "Error(TErrorStatus status, IError innerError)" +file = "Flow\\Error.cs" + +[[ctors]] +parent = "Error" +sig = "Error(TErrorStatus status, IError innerError, string message)" +file = "Flow\\Error.cs" + +[[classes]] +name = "ExceptionError" +ns = "FEx.Agnostics.Abstractions.Flow" +base = "Error, IExceptionError" +file = "Flow\\ExceptionError.cs" + +[[properties]] +parent = "ExceptionError" +name = "Exception" +sig = "Exception Exception { get; }" +returns = "Exception" +file = "Flow\\ExceptionError.cs" + +[[properties]] +parent = "ExceptionError" +name = "StackTrace" +sig = "string StackTrace { get; }" +returns = "string" +file = "Flow\\ExceptionError.cs" + +[[properties]] +parent = "ExceptionError" +name = "RootErrorStackTrace" +sig = "string RootErrorStackTrace { get; }" +returns = "string" +file = "Flow\\ExceptionError.cs" + +[[ctors]] +parent = "ExceptionError" +sig = "ExceptionError()" +file = "Flow\\ExceptionError.cs" + +[[ctors]] +parent = "ExceptionError" +sig = "ExceptionError(Exception exception, string message = null)" +file = "Flow\\ExceptionError.cs" + +[[classes]] +name = "FExErrorEventArgs" +ns = "FEx.Agnostics.Abstractions.Flow" +base = "EventArgs" +file = "Flow\\FExErrorEventArgs.cs" + +[[properties]] +parent = "FExErrorEventArgs" +name = "Message" +sig = "string Message { get; }" +returns = "string" +file = "Flow\\FExErrorEventArgs.cs" + +[[properties]] +parent = "FExErrorEventArgs" +name = "Exception" +sig = "Exception Exception { get; }" +returns = "Exception" +file = "Flow\\FExErrorEventArgs.cs" + +[[ctors]] +parent = "FExErrorEventArgs" +sig = "FExErrorEventArgs(string message)" +file = "Flow\\FExErrorEventArgs.cs" + +[[ctors]] +parent = "FExErrorEventArgs" +sig = "FExErrorEventArgs(string message, Exception exception)" +file = "Flow\\FExErrorEventArgs.cs" + +[[classes]] +name = "Result" +ns = "FEx.Agnostics.Abstractions.Flow" +base = "ResultBase" +file = "Flow\\Result.cs" + +[[properties]] +parent = "Result" +name = "Success" +sig = "static Result Success { get; }" +returns = "Result" +file = "Flow\\Result.cs" +static = true + +[[properties]] +parent = "Result" +name = "Failure" +sig = "static Result Failure { get; }" +returns = "Result" +file = "Flow\\Result.cs" +static = true + +[[ctors]] +parent = "Result" +sig = "Result()" +file = "Flow\\Result.cs" + +[[ctors]] +parent = "Result" +sig = "Result(TError error)" +file = "Flow\\Result.cs" + +[[classes]] +name = "Result" +ns = "FEx.Agnostics.Abstractions.Flow" +base = "ResultBase, IResult" +file = "Flow\\Result.cs" + +[[properties]] +parent = "Result" +name = "Failure" +sig = "static Result Failure { get; }" +returns = "Result" +file = "Flow\\Result.cs" +static = true + +[[properties]] +parent = "Result" +name = "Data" +sig = "TData Data { get; }" +returns = "TData" +file = "Flow\\Result.cs" + +[[ctors]] +parent = "Result" +sig = "Result(TData data)" +file = "Flow\\Result.cs" + +[[ctors]] +parent = "Result" +sig = "Result(TError error)" +file = "Flow\\Result.cs" + +[[methods]] +parent = "Result" +name = "TryGetData" +sig = "bool TryGetData(out TData data)" +returns = "bool" +file = "Flow\\Result.cs" + +[[methods]] +parent = "Result" +name = "Success" +sig = "static Result Success(TData data)" +returns = "Result" +file = "Flow\\Result.cs" +static = true + +[[classes]] +name = "ResultBase" +ns = "FEx.Agnostics.Abstractions.Flow" +base = "IResult" +file = "Flow\\ResultBase.cs" + +[[properties]] +parent = "ResultBase" +name = "Error" +sig = "TError Error { get; }" +returns = "TError" +file = "Flow\\ResultBase.cs" + +[[properties]] +parent = "ResultBase" +name = "IsSuccess" +sig = "bool IsSuccess { get; }" +returns = "bool" +file = "Flow\\ResultBase.cs" + +[[properties]] +parent = "ResultBase" +name = "IsFailure" +sig = "bool IsFailure { get; }" +returns = "bool" +file = "Flow\\ResultBase.cs" + +[[ctors]] +parent = "ResultBase" +sig = "ResultBase()" +file = "Flow\\ResultBase.cs" + +[[ctors]] +parent = "ResultBase" +sig = "ResultBase(TError error)" +file = "Flow\\ResultBase.cs" + +[[classes]] +name = "EventArgsCache" +ns = "FEx.Agnostics.Abstractions.Helpers" +file = "Helpers\\EventArgsCache.cs" +static = true + +[[classes]] +name = "FExValueTaskHelper" +ns = "FEx.Agnostics.Abstractions.Helpers" +file = "Helpers\\FExValueTaskHelper.cs" +static = true + +[[properties]] +parent = "FExValueTaskHelper" +name = "CompletedTask" +sig = "static ValueTask CompletedTask { get; }" +returns = "ValueTask" +file = "Helpers\\FExValueTaskHelper.cs" +static = true + +[[classes]] +name = "FileSystemHelper" +ns = "FEx.Agnostics.Abstractions.Helpers" +file = "Helpers\\FileSystemHelper.cs" +static = true + +[[properties]] +parent = "FileSystemHelper" +name = "InvalidPathChars" +sig = "static char[] InvalidPathChars { get; }" +returns = "char[]" +file = "Helpers\\FileSystemHelper.cs" +static = true + +[[properties]] +parent = "FileSystemHelper" +name = "InvalidFileOrDirNameChars" +sig = "static char[] InvalidFileOrDirNameChars { get; }" +returns = "char[]" +file = "Helpers\\FileSystemHelper.cs" +static = true + +[[properties]] +parent = "FileSystemHelper" +name = "InvalidFileNameChars" +sig = "static HashSet InvalidFileNameChars { get; }" +returns = "HashSet" +file = "Helpers\\FileSystemHelper.cs" +static = true + +[[methods]] +parent = "FileSystemHelper" +name = "IsPathNtfs" +sig = "static bool IsPathNtfs(string absolutePath)" +returns = "bool" +summary = "Determines whether [is path NTFS] [the specified absolute file path]." +file = "Helpers\\FileSystemHelper.cs" +static = true + +[[methods]] +parent = "FileSystemHelper" +name = "GenerateMd5OfFile" +sig = "static string GenerateMd5OfFile(string filePath)" +returns = "string" +summary = "Generates the md5 of file." +file = "Helpers\\FileSystemHelper.cs" +static = true + +[[methods]] +parent = "FileSystemHelper" +name = "GetParentFolderFromPath" +sig = "static string GetParentFolderFromPath(string path, char pathSeparator, bool includeSeparatorAtEnd)" +returns = "string" +file = "Helpers\\FileSystemHelper.cs" +static = true + +[[methods]] +parent = "FileSystemHelper" +name = "FixPath" +sig = "static string FixPath(string path)" +returns = "string" +file = "Helpers\\FileSystemHelper.cs" +static = true + +[[classes]] +name = "HashHelper" +ns = "FEx.Agnostics.Abstractions.Helpers" +file = "Helpers\\HashHelper.cs" +static = true + +[[extensions]] +name = "GetHashString" +returns = "string" +sig = "string GetHashString(this byte[] hash, bool removeDashes = true, bool toLower = true, bool asBase64String = false)" +file = "Helpers\\HashHelper.cs" + +[[classes]] +name = "LambdaEqualityHelper" +ns = "FEx.Agnostics.Abstractions.Helpers" +file = "Helpers\\LambdaEqualityHelper.cs" + +[[ctors]] +parent = "LambdaEqualityHelper" +sig = "LambdaEqualityHelper(params Func[] equalityContributorAccessors)" +file = "Helpers\\LambdaEqualityHelper.cs" + +[[methods]] +parent = "LambdaEqualityHelper" +name = "Equals" +sig = "bool Equals(T instance, T other)" +returns = "bool" +file = "Helpers\\LambdaEqualityHelper.cs" + +[[methods]] +parent = "LambdaEqualityHelper" +name = "GetHashCode" +sig = "int GetHashCode(T instance)" +returns = "int" +file = "Helpers\\LambdaEqualityHelper.cs" + +[[interfaces]] +name = "IAppInfo" +ns = "FEx.Agnostics.Abstractions.Interfaces" +file = "Interfaces\\IAppInfo.cs" + +[[properties]] +parent = "IAppInfo" +name = "Name" +sig = "string Name { get; }" +returns = "string" +file = "Interfaces\\IAppInfo.cs" + +[[properties]] +parent = "IAppInfo" +name = "Version" +sig = "Version Version { get; }" +returns = "Version" +file = "Interfaces\\IAppInfo.cs" + +[[properties]] +parent = "IAppInfo" +name = "Company" +sig = "string Company { get; }" +returns = "string" +file = "Interfaces\\IAppInfo.cs" + +[[properties]] +parent = "IAppInfo" +name = "IsUIApp" +sig = "bool IsUIApp { get; set; }" +returns = "bool" +file = "Interfaces\\IAppInfo.cs" + +[[properties]] +parent = "IAppInfo" +name = "UserData" +sig = "DirectoryInfo UserData { get; }" +returns = "DirectoryInfo" +file = "Interfaces\\IAppInfo.cs" + +[[properties]] +parent = "IAppInfo" +name = "AppData" +sig = "DirectoryInfo AppData { get; }" +returns = "DirectoryInfo" +file = "Interfaces\\IAppInfo.cs" + +[[properties]] +parent = "IAppInfo" +name = "LogDirPath" +sig = "string LogDirPath { get; }" +returns = "string" +file = "Interfaces\\IAppInfo.cs" + +[[interfaces]] +name = "IAppInfoProvider" +ns = "FEx.Agnostics.Abstractions.Interfaces" +file = "Interfaces\\IAppInfoProvider.cs" + +[[properties]] +parent = "IAppInfoProvider" +name = "EntryAssemblyName" +sig = "string EntryAssemblyName { get; }" +returns = "string" +file = "Interfaces\\IAppInfoProvider.cs" + +[[properties]] +parent = "IAppInfoProvider" +name = "EntryAssembly" +sig = "Assembly EntryAssembly { get; }" +returns = "Assembly" +file = "Interfaces\\IAppInfoProvider.cs" + +[[properties]] +parent = "IAppInfoProvider" +name = "EntryAssemblyLocation" +sig = "FileInfo EntryAssemblyLocation { get; }" +returns = "FileInfo" +file = "Interfaces\\IAppInfoProvider.cs" + +[[properties]] +parent = "IAppInfoProvider" +name = "Name" +sig = "string Name { get; }" +returns = "string" +file = "Interfaces\\IAppInfoProvider.cs" + +[[properties]] +parent = "IAppInfoProvider" +name = "Version" +sig = "Version Version { get; }" +returns = "Version" +file = "Interfaces\\IAppInfoProvider.cs" + +[[properties]] +parent = "IAppInfoProvider" +name = "VersionString" +sig = "string VersionString { get; }" +returns = "string" +file = "Interfaces\\IAppInfoProvider.cs" + +[[properties]] +parent = "IAppInfoProvider" +name = "Company" +sig = "string Company { get; }" +returns = "string" +file = "Interfaces\\IAppInfoProvider.cs" + +[[properties]] +parent = "IAppInfoProvider" +name = "Copyright" +sig = "string Copyright { get; }" +returns = "string" +file = "Interfaces\\IAppInfoProvider.cs" + +[[properties]] +parent = "IAppInfoProvider" +name = "NameAndVersionWithPrefix" +sig = "string NameAndVersionWithPrefix { get; }" +returns = "string" +file = "Interfaces\\IAppInfoProvider.cs" + +[[properties]] +parent = "IAppInfoProvider" +name = "NameLineVersion" +sig = "string NameLineVersion { get; }" +returns = "string" +file = "Interfaces\\IAppInfoProvider.cs" + +[[properties]] +parent = "IAppInfoProvider" +name = "NameLineVersionWithPrefix" +sig = "string NameLineVersionWithPrefix { get; }" +returns = "string" +file = "Interfaces\\IAppInfoProvider.cs" + +[[properties]] +parent = "IAppInfoProvider" +name = "NameAndVersion" +sig = "string NameAndVersion { get; }" +returns = "string" +file = "Interfaces\\IAppInfoProvider.cs" + +[[properties]] +parent = "IAppInfoProvider" +name = "UserData" +sig = "DirectoryInfo UserData { get; }" +returns = "DirectoryInfo" +file = "Interfaces\\IAppInfoProvider.cs" + +[[properties]] +parent = "IAppInfoProvider" +name = "UserDataPath" +sig = "string UserDataPath { get; }" +returns = "string" +file = "Interfaces\\IAppInfoProvider.cs" + +[[properties]] +parent = "IAppInfoProvider" +name = "AppData" +sig = "DirectoryInfo AppData { get; }" +returns = "DirectoryInfo" +file = "Interfaces\\IAppInfoProvider.cs" + +[[properties]] +parent = "IAppInfoProvider" +name = "AppDataPath" +sig = "string AppDataPath { get; }" +returns = "string" +file = "Interfaces\\IAppInfoProvider.cs" + +[[properties]] +parent = "IAppInfoProvider" +name = "UserSettingsPath" +sig = "string UserSettingsPath { get; }" +returns = "string" +file = "Interfaces\\IAppInfoProvider.cs" + +[[properties]] +parent = "IAppInfoProvider" +name = "AppInfo" +sig = "IAppInfo AppInfo { get; }" +returns = "IAppInfo" +file = "Interfaces\\IAppInfoProvider.cs" + +[[interfaces]] +name = "IAppVersionProvider" +ns = "FEx.Agnostics.Abstractions.Interfaces" +file = "Interfaces\\IAppVersionProvider.cs" + +[[methods]] +parent = "IAppVersionProvider" +name = "GetAppVersion" +sig = "string GetAppVersion()" +returns = "string" +file = "Interfaces\\IAppVersionProvider.cs" + +[[interfaces]] +name = "IAsyncHelper" +ns = "FEx.Agnostics.Abstractions.Interfaces" +file = "Interfaces\\IAsyncHelper.cs" + +[[methods]] +parent = "IAsyncHelper" +name = "FireAndForget" +sig = "ITaskWrapper FireAndForget(Action action, AsyncMode asyncMode = AsyncMode.Default, IExceptionHandlerOptions options = null, CancellationToken cancellationToken = default)" +returns = "ITaskWrapper" +file = "Interfaces\\IAsyncHelper.cs" + +[[methods]] +parent = "IAsyncHelper" +name = "FireAndForget" +sig = "ITaskWrapper FireAndForget(Func func, AsyncMode asyncMode = AsyncMode.Default, IExceptionHandlerOptions options = null, CancellationToken cancellationToken = default)" +returns = "ITaskWrapper" +file = "Interfaces\\IAsyncHelper.cs" + +[[methods]] +parent = "IAsyncHelper" +name = "FireTaskAndForget" +sig = "ITaskWrapper FireTaskAndForget(Func task, AsyncMode asyncMode = AsyncMode.Default, IExceptionHandlerOptions options = null)" +returns = "ITaskWrapper" +file = "Interfaces\\IAsyncHelper.cs" + +[[methods]] +parent = "IAsyncHelper" +name = "FireTaskAndForget" +sig = "ITaskWrapper FireTaskAndForget(Func> task, AsyncMode asyncMode = AsyncMode.Default, IExceptionHandlerOptions options = null)" +returns = "ITaskWrapper" +file = "Interfaces\\IAsyncHelper.cs" + +[[methods]] +parent = "IAsyncHelper" +name = "FireTasksAndForget" +sig = "IReadOnlyList FireTasksAndForget(IEnumerable> tasks, AsyncMode asyncMode = AsyncMode.Default, IExceptionHandlerOptions options = null)" +returns = "IReadOnlyList" +file = "Interfaces\\IAsyncHelper.cs" + +[[methods]] +parent = "IAsyncHelper" +name = "FireTasksAndForget" +sig = "IReadOnlyList> FireTasksAndForget(IEnumerable>> tasks, AsyncMode asyncMode = AsyncMode.Default, IExceptionHandlerOptions options = null)" +returns = "IReadOnlyList>" +file = "Interfaces\\IAsyncHelper.cs" + +[[methods]] +parent = "IAsyncHelper" +name = "ExecuteDeferredTaskOnMainThreadAsync" +sig = "Task ExecuteDeferredTaskOnMainThreadAsync(Action func, AsyncOptions options = AsyncOptions.ImmediateStart)" +returns = "Task" +file = "Interfaces\\IAsyncHelper.cs" + +[[methods]] +parent = "IAsyncHelper" +name = "ExecuteDeferredTaskOnMainThreadAsync" +sig = "Task ExecuteDeferredTaskOnMainThreadAsync(Func func, AsyncOptions options = AsyncOptions.ImmediateStart)" +returns = "Task" +file = "Interfaces\\IAsyncHelper.cs" + +[[methods]] +parent = "IAsyncHelper" +name = "ExecuteDeferredTaskOnMainThreadAsync" +sig = "Task ExecuteDeferredTaskOnMainThreadAsync(Func func, AsyncOptions options = AsyncOptions.ImmediateStart)" +returns = "Task" +file = "Interfaces\\IAsyncHelper.cs" + +[[methods]] +parent = "IAsyncHelper" +name = "ExecuteDeferredTaskOnMainThreadAsync" +sig = "Task ExecuteDeferredTaskOnMainThreadAsync(Func> func, AsyncOptions options = AsyncOptions.ImmediateStart)" +returns = "Task" +file = "Interfaces\\IAsyncHelper.cs" + +[[interfaces]] +name = "IConcurrentList" +ns = "FEx.Agnostics.Abstractions.Interfaces" +base = "IList, IReadOnlyList, IList, ISuppressEvents" +file = "Interfaces\\IConcurrentList.cs" + +[[properties]] +parent = "IConcurrentList" +name = "Config" +sig = "CollectionEventsConfig Config { get; }" +returns = "CollectionEventsConfig" +file = "Interfaces\\IConcurrentList.cs" + +[[properties]] +parent = "IConcurrentList" +name = "IsEmpty" +sig = "bool IsEmpty { get; }" +returns = "bool" +file = "Interfaces\\IConcurrentList.cs" + +[[methods]] +parent = "IConcurrentList" +name = "AddRange" +sig = "void AddRange(IEnumerable range)" +returns = "void" +summary = "Adds the specified items to this collection." +file = "Interfaces\\IConcurrentList.cs" + +[[methods]] +parent = "IConcurrentList" +name = "AsReadOnly" +sig = "ReadOnlyCollection AsReadOnly()" +returns = "ReadOnlyCollection" +file = "Interfaces\\IConcurrentList.cs" + +[[methods]] +parent = "IConcurrentList" +name = "AddUnique" +sig = "bool AddUnique(T item)" +returns = "bool" +summary = "Adds an object to the end of the if it not exists in it yet." +file = "Interfaces\\IConcurrentList.cs" + +[[methods]] +parent = "IConcurrentList" +name = "AddUniqueRange" +sig = "void AddUniqueRange(IEnumerable range)" +returns = "void" +file = "Interfaces\\IConcurrentList.cs" + +[[methods]] +parent = "IConcurrentList" +name = "AddUniqueRange" +sig = "void AddUniqueRange(IEnumerable range, Func keySelector, IEqualityComparer comparer)" +returns = "void" +file = "Interfaces\\IConcurrentList.cs" + +[[methods]] +parent = "IConcurrentList" +name = "RemoveWhere" +sig = "bool RemoveWhere(Func predicate, out List removedItems)" +returns = "bool" +file = "Interfaces\\IConcurrentList.cs" + +[[methods]] +parent = "IConcurrentList" +name = "Replace" +sig = "void Replace(int index, T item)" +returns = "void" +file = "Interfaces\\IConcurrentList.cs" + +[[methods]] +parent = "IConcurrentList" +name = "ReplaceWith" +sig = "void ReplaceWith(IEnumerable collection)" +returns = "void" +file = "Interfaces\\IConcurrentList.cs" + +[[methods]] +parent = "IConcurrentList" +name = "Sort" +sig = "void Sort()" +returns = "void" +summary = "Sorts the elements using the default comparer." +file = "Interfaces\\IConcurrentList.cs" + +[[methods]] +parent = "IConcurrentList" +name = "Sort" +sig = "void Sort(IComparer comparer)" +returns = "void" +summary = "Sorts the elements using the specified comparer." +file = "Interfaces\\IConcurrentList.cs" + +[[methods]] +parent = "IConcurrentList" +name = "Sort" +sig = "void Sort(int index, int count, IComparer comparer)" +returns = "void" +summary = "Sorts the elements in a range of elements using the specified comparer." +file = "Interfaces\\IConcurrentList.cs" + +[[methods]] +parent = "IConcurrentList" +name = "Sort" +sig = "void Sort(Comparison comparison)" +returns = "void" +summary = "Sorts the elements using the specified ." +file = "Interfaces\\IConcurrentList.cs" + +[[methods]] +parent = "IConcurrentList" +name = "SortBy" +sig = "void SortBy(Func selector, ListSortDirection order, IComparer comparer)" +returns = "void" +file = "Interfaces\\IConcurrentList.cs" + +[[methods]] +parent = "IConcurrentList" +name = "Combo" +sig = "void Combo(Action> action, bool shouldTriggerCollectionReset)" +returns = "void" +summary = "Suppresses all events regarding this collection while executing the specified action. event is fired afterward." +file = "Interfaces\\IConcurrentList.cs" + +[[methods]] +parent = "IConcurrentList" +name = "Combo" +sig = "bool Combo(Func, bool> shouldTriggerCollectionReset)" +returns = "bool" +file = "Interfaces\\IConcurrentList.cs" + +[[methods]] +parent = "IConcurrentList" +name = "Move" +sig = "void Move(int oldIndex, int newIndex)" +returns = "void" +summary = "Move item at oldIndex to newIndex." +file = "Interfaces\\IConcurrentList.cs" + +[[interfaces]] +name = "IExceptionHandlerOptions" +ns = "FEx.Agnostics.Abstractions.Interfaces" +file = "Interfaces\\IExceptionHandlerOptions.cs" + +[[properties]] +parent = "IExceptionHandlerOptions" +name = "InformUser" +sig = "bool InformUser { get; set; }" +returns = "bool" +file = "Interfaces\\IExceptionHandlerOptions.cs" + +[[properties]] +parent = "IExceptionHandlerOptions" +name = "Wait" +sig = "bool Wait { get; set; }" +returns = "bool" +file = "Interfaces\\IExceptionHandlerOptions.cs" + +[[properties]] +parent = "IExceptionHandlerOptions" +name = "DoNotReport" +sig = "bool DoNotReport { get; set; }" +returns = "bool" +file = "Interfaces\\IExceptionHandlerOptions.cs" + +[[properties]] +parent = "IExceptionHandlerOptions" +name = "Custom" +sig = "IDictionary Custom { get; set; }" +returns = "IDictionary" +file = "Interfaces\\IExceptionHandlerOptions.cs" + +[[interfaces]] +name = "IFExInitializable" +ns = "FEx.Agnostics.Abstractions.Interfaces" +file = "Interfaces\\IFExInitializable.cs" + +[[properties]] +parent = "IFExInitializable" +name = "IsInitialized" +sig = "bool IsInitialized { get; }" +returns = "bool" +file = "Interfaces\\IFExInitializable.cs" + +[[methods]] +parent = "IFExInitializable" +name = "Initialize" +sig = "void Initialize()" +returns = "void" +file = "Interfaces\\IFExInitializable.cs" + +[[interfaces]] +name = "IFExLogger" +ns = "FEx.Agnostics.Abstractions.Interfaces" +summary = "Framework-agnostic logger interface aligned with Microsoft.Extensions.Logging semantics. Provides leveled logging (Trace/Debug/Info/Warning/Error/Critical), structured logging via scopes/labels, and low-level error event hooks." +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "Trace" +sig = "void Trace(string message)" +returns = "void" +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "Trace" +sig = "void Trace(Exception exception, string message)" +returns = "void" +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "Debug" +sig = "void Debug(string message)" +returns = "void" +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "Debug" +sig = "void Debug(Exception exception, string message)" +returns = "void" +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "Information" +sig = "void Information(string message)" +returns = "void" +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "Information" +sig = "void Information(Exception exception, string message)" +returns = "void" +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "Warning" +sig = "void Warning(string message)" +returns = "void" +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "Warning" +sig = "void Warning(Exception exception, string message)" +returns = "void" +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "Error" +sig = "void Error(string message)" +returns = "void" +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "Error" +sig = "void Error(Exception exception, string message)" +returns = "void" +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "Critical" +sig = "void Critical(string message)" +returns = "void" +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "Critical" +sig = "void Critical(Exception exception, string message)" +returns = "void" +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "BeginScope" +sig = "IDisposable BeginScope(TState state)" +returns = "IDisposable" +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "BeginLabeledScope" +sig = "IDisposable BeginLabeledScope(params (string, object)[] state)" +returns = "IDisposable" +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "BeginLabeledScope" +sig = "IDisposable BeginLabeledScope(IDictionary argsCustom)" +returns = "IDisposable" +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "BeginLabeledScope" +sig = "IDisposable BeginLabeledScope(ILoggerState state)" +returns = "IDisposable" +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "EndScope" +sig = "void EndScope()" +returns = "void" +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "AddOrUpdateLabel" +sig = "void AddOrUpdateLabel(string key, object value)" +returns = "void" +file = "Interfaces\\IFExLogger.cs" + +[[methods]] +parent = "IFExLogger" +name = "RemoveLabel" +sig = "void RemoveLabel(string key)" +returns = "void" +file = "Interfaces\\IFExLogger.cs" + +[[interfaces]] +name = "IFExMemoryCache" +ns = "FEx.Agnostics.Abstractions.Interfaces" +base = "IDictionary, IDictionary" +file = "Interfaces\\IFExMemoryCache.cs" + +[[methods]] +parent = "IFExMemoryCache" +name = "AddOrUpdate" +sig = "TValue AddOrUpdate(TKey key, TValue addValue, Func updateValueFactory)" +returns = "TValue" +file = "Interfaces\\IFExMemoryCache.cs" + +[[interfaces]] +name = "IFExNotifyPropertyChanged" +ns = "FEx.Agnostics.Abstractions.Interfaces" +base = "INotifyPropertyChanged" +file = "Interfaces\\IFExNotifyPropertyChanged.cs" + +[[methods]] +parent = "IFExNotifyPropertyChanged" +name = "OnPropertyChanged" +sig = "void OnPropertyChanged([CallerMemberName] string propertyName = null)" +returns = "void" +file = "Interfaces\\IFExNotifyPropertyChanged.cs" + +[[methods]] +parent = "IFExNotifyPropertyChanged" +name = "OnPropertiesChanged" +sig = "void OnPropertiesChanged(params string[] propertyNames)" +returns = "void" +file = "Interfaces\\IFExNotifyPropertyChanged.cs" + +[[methods]] +parent = "IFExNotifyPropertyChanged" +name = "SetProperty" +sig = "bool SetProperty(ref TRet backingField, TRet newValue, Action onPropertyChanged = null, [CallerMemberName] string propertyName = null)" +returns = "bool" +file = "Interfaces\\IFExNotifyPropertyChanged.cs" + +[[methods]] +parent = "IFExNotifyPropertyChanged" +name = "OnPropertySet" +sig = "void OnPropertySet(T oldValue, T newValue, string propertyName)" +returns = "void" +file = "Interfaces\\IFExNotifyPropertyChanged.cs" + +[[interfaces]] +name = "IFExPriorityInitialize" +ns = "FEx.Agnostics.Abstractions.Interfaces" +base = "IFExInitializable" +file = "Interfaces\\IFExPriorityInitialize.cs" + +[[properties]] +parent = "IFExPriorityInitialize" +name = "Priority" +sig = "int Priority { get; }" +returns = "int" +summary = "Priority of initialization - lower value is higher priority" +file = "Interfaces\\IFExPriorityInitialize.cs" + +[[interfaces]] +name = "ILoggerState" +ns = "FEx.Agnostics.Abstractions.Interfaces" +base = "IDictionary, IDictionary, IReadOnlyDictionary, ISerializable, IDeserializationCallback" +summary = "Represents a mutable dictionary of logging state/labels for structured logging scopes." +file = "Interfaces\\ILoggerState.cs" + +[[methods]] +parent = "ILoggerState" +name = "AddOrUpdateLabel" +sig = "void AddOrUpdateLabel(string key, object value)" +returns = "void" +file = "Interfaces\\ILoggerState.cs" + +[[methods]] +parent = "ILoggerState" +name = "RemoveLabel" +sig = "void RemoveLabel(string key)" +returns = "void" +file = "Interfaces\\ILoggerState.cs" + +[[interfaces]] +name = "ISuppressEvents" +ns = "FEx.Agnostics.Abstractions.Interfaces" +file = "Interfaces\\ISuppressEvents.cs" + +[[properties]] +parent = "ISuppressEvents" +name = "EventsAreSuppressed" +sig = "bool EventsAreSuppressed { get; }" +returns = "bool" +file = "Interfaces\\ISuppressEvents.cs" + +[[properties]] +parent = "ISuppressEvents" +name = "SuppressedEvents" +sig = "int SuppressedEvents { get; set; }" +returns = "int" +file = "Interfaces\\ISuppressEvents.cs" + +[[methods]] +parent = "ISuppressEvents" +name = "SuppressEvents" +sig = "SuppressEventsDisposable SuppressEvents()" +returns = "SuppressEventsDisposable" +file = "Interfaces\\ISuppressEvents.cs" + +[[interfaces]] +name = "ISynchronizedAccessService" +ns = "FEx.Agnostics.Abstractions.Interfaces" +file = "Interfaces\\ISynchronizedAccessService.cs" + +[[methods]] +parent = "ISynchronizedAccessService" +name = "EnsureLock" +sig = "SemaphoreSlim EnsureLock(string key, int maxParallel = 1)" +returns = "SemaphoreSlim" +file = "Interfaces\\ISynchronizedAccessService.cs" + +[[methods]] +parent = "ISynchronizedAccessService" +name = "RunLocked" +sig = "void RunLocked(Action action, string key, CancellationToken cancellationToken = default)" +returns = "void" +file = "Interfaces\\ISynchronizedAccessService.cs" + +[[methods]] +parent = "ISynchronizedAccessService" +name = "RunLocked" +sig = "T RunLocked(Func action, string key, CancellationToken cancellationToken = default)" +returns = "T" +file = "Interfaces\\ISynchronizedAccessService.cs" + +[[methods]] +parent = "ISynchronizedAccessService" +name = "RunLockedAsync" +sig = "Task RunLockedAsync(Action action, string key, CancellationToken cancellationToken = default)" +returns = "Task" +file = "Interfaces\\ISynchronizedAccessService.cs" + +[[methods]] +parent = "ISynchronizedAccessService" +name = "RunLockedAsync" +sig = "Task RunLockedAsync(Func action, string key, CancellationToken cancellationToken = default)" +returns = "Task" +file = "Interfaces\\ISynchronizedAccessService.cs" + +[[methods]] +parent = "ISynchronizedAccessService" +name = "Release" +sig = "void Release(string key)" +returns = "void" +file = "Interfaces\\ISynchronizedAccessService.cs" + +[[methods]] +parent = "ISynchronizedAccessService" +name = "WaitAsync" +sig = "Task WaitAsync(string key, int maxParallel = 1, CancellationToken cancellationToken = default)" +returns = "Task" +file = "Interfaces\\ISynchronizedAccessService.cs" + +[[methods]] +parent = "ISynchronizedAccessService" +name = "Wait" +sig = "void Wait(string key, int maxParallel = 1, CancellationToken cancellationToken = default)" +returns = "void" +file = "Interfaces\\ISynchronizedAccessService.cs" + +[[methods]] +parent = "ISynchronizedAccessService" +name = "RemoveLock" +sig = "void RemoveLock(string key)" +returns = "void" +file = "Interfaces\\ISynchronizedAccessService.cs" + +[[interfaces]] +name = "ITaskWrapper" +ns = "FEx.Agnostics.Abstractions.Interfaces" +base = "ITaskWrapperBase>" +file = "Interfaces\\ITaskWrapper.cs" + +[[interfaces]] +name = "ITaskWrapper" +ns = "FEx.Agnostics.Abstractions.Interfaces" +base = "ITaskWrapperBase, Result>" +file = "Interfaces\\ITaskWrapper.cs" + +[[interfaces]] +name = "ITaskWrapperBase" +ns = "FEx.Agnostics.Abstractions.Interfaces" +base = "ITaskWrapperBase" +file = "Interfaces\\ITaskWrapperBase.cs" + +[[properties]] +parent = "ITaskWrapperBase" +name = "Result" +sig = "TResult Result { get; }" +returns = "TResult" +file = "Interfaces\\ITaskWrapperBase.cs" + +[[properties]] +parent = "ITaskWrapperBase" +name = "Task" +sig = "TTask Task { get; }" +returns = "TTask" +file = "Interfaces\\ITaskWrapperBase.cs" + +[[methods]] +parent = "ITaskWrapperBase" +name = "SetTask" +sig = "void SetTask(Func task)" +returns = "void" +file = "Interfaces\\ITaskWrapperBase.cs" + +[[interfaces]] +name = "ITaskWrapperBase" +ns = "FEx.Agnostics.Abstractions.Interfaces" +file = "Interfaces\\ITaskWrapperBase.cs" + +[[properties]] +parent = "ITaskWrapperBase" +name = "Id" +sig = "Guid Id { get; }" +returns = "Guid" +file = "Interfaces\\ITaskWrapperBase.cs" + +[[properties]] +parent = "ITaskWrapperBase" +name = "IsFinished" +sig = "bool IsFinished { get; }" +returns = "bool" +file = "Interfaces\\ITaskWrapperBase.cs" + +[[properties]] +parent = "ITaskWrapperBase" +name = "TaskCreationStackTrace" +sig = "StackTrace TaskCreationStackTrace { get; }" +returns = "StackTrace" +file = "Interfaces\\ITaskWrapperBase.cs" + +[[methods]] +parent = "ITaskWrapperBase" +name = "SetException" +sig = "void SetException(Exception exception)" +returns = "void" +file = "Interfaces\\ITaskWrapperBase.cs" + +[[classes]] +name = "SpecialDirectory" +ns = "FEx.Agnostics.Abstractions.IO" +file = "IO\\SpecialDirectory.cs" + +[[properties]] +parent = "SpecialDirectory" +name = "SpecialDirectories" +sig = "static IReadOnlyDictionary SpecialDirectories { get; }" +returns = "IReadOnlyDictionary" +file = "IO\\SpecialDirectory.cs" +static = true + +[[properties]] +parent = "SpecialDirectory" +name = "DirectoryType" +sig = "Environment.SpecialFolder DirectoryType { get; }" +returns = "Environment.SpecialFolder" +file = "IO\\SpecialDirectory.cs" + +[[properties]] +parent = "SpecialDirectory" +name = "Directory" +sig = "DirectoryInfo Directory { get; }" +returns = "DirectoryInfo" +file = "IO\\SpecialDirectory.cs" + +[[properties]] +parent = "SpecialDirectory" +name = "FullName" +sig = "string FullName { get; }" +returns = "string" +file = "IO\\SpecialDirectory.cs" + +[[ctors]] +parent = "SpecialDirectory" +sig = "SpecialDirectory(Environment.SpecialFolder directoryType, DirectoryInfo directory)" +file = "IO\\SpecialDirectory.cs" + +[[ctors]] +parent = "SpecialDirectory" +sig = "SpecialDirectory(Environment.SpecialFolder directoryType, string directory)" +file = "IO\\SpecialDirectory.cs" + +[[methods]] +parent = "SpecialDirectory" +name = "GetExistingDirectories" +sig = "static IDictionary GetExistingDirectories()" +returns = "IDictionary" +file = "IO\\SpecialDirectory.cs" +static = true + +[[methods]] +parent = "SpecialDirectory" +name = "ToString" +sig = "string ToString()" +returns = "string" +file = "IO\\SpecialDirectory.cs" + +[[classes]] +name = "FExDebugLogger" +ns = "FEx.Agnostics.Abstractions.Logging" +base = "IFExLogger" +summary = "Simple debug console logger implementation (no structured logging support)." +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "Trace" +sig = "void Trace(string message)" +returns = "void" +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "Trace" +sig = "void Trace(Exception exception, string message)" +returns = "void" +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "Debug" +sig = "void Debug(string message)" +returns = "void" +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "Debug" +sig = "void Debug(Exception exception, string message)" +returns = "void" +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "Information" +sig = "void Information(string message)" +returns = "void" +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "Information" +sig = "void Information(Exception exception, string message)" +returns = "void" +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "Warning" +sig = "void Warning(string message)" +returns = "void" +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "Warning" +sig = "void Warning(Exception exception, string message)" +returns = "void" +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "Error" +sig = "void Error(string message)" +returns = "void" +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "Error" +sig = "void Error(Exception exception, string message)" +returns = "void" +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "Critical" +sig = "void Critical(string message)" +returns = "void" +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "Critical" +sig = "void Critical(Exception exception, string message)" +returns = "void" +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "BeginScope" +sig = "IDisposable BeginScope(TState state)" +returns = "IDisposable" +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "BeginLabeledScope" +sig = "IDisposable BeginLabeledScope(params (string, object)[] state)" +returns = "IDisposable" +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "BeginLabeledScope" +sig = "IDisposable BeginLabeledScope(IDictionary argsCustom)" +returns = "IDisposable" +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "BeginLabeledScope" +sig = "IDisposable BeginLabeledScope(ILoggerState state)" +returns = "IDisposable" +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "EndScope" +sig = "void EndScope()" +returns = "void" +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "AddOrUpdateLabel" +sig = "void AddOrUpdateLabel(string key, object value)" +returns = "void" +file = "Logging\\FExDebugLogger.cs" + +[[methods]] +parent = "FExDebugLogger" +name = "RemoveLabel" +sig = "void RemoveLabel(string key)" +returns = "void" +file = "Logging\\FExDebugLogger.cs" + +[[classes]] +name = "FExStaticLogger" +ns = "FEx.Agnostics.Abstractions.Logging" +base = "FExInitializable" +file = "Logging\\FExStaticLogger.cs" + +[[properties]] +parent = "FExStaticLogger" +name = "Instance" +sig = "static IFExLogger Instance { get; }" +returns = "IFExLogger" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[properties]] +parent = "FExStaticLogger" +name = "Logger" +sig = "static IFExLogger Logger { get; }" +returns = "IFExLogger" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[ctors]] +parent = "FExStaticLogger" +sig = "FExStaticLogger(IFExLogger logger)" +file = "Logging\\FExStaticLogger.cs" + +[[methods]] +parent = "FExStaticLogger" +name = "Debug" +sig = "static void Debug(string message)" +returns = "void" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[methods]] +parent = "FExStaticLogger" +name = "Debug" +sig = "static void Debug(Exception exception)" +returns = "void" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[methods]] +parent = "FExStaticLogger" +name = "Debug" +sig = "static void Debug(Exception exception, string message)" +returns = "void" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[methods]] +parent = "FExStaticLogger" +name = "Information" +sig = "static void Information(string message)" +returns = "void" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[methods]] +parent = "FExStaticLogger" +name = "Information" +sig = "static void Information(Exception exception)" +returns = "void" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[methods]] +parent = "FExStaticLogger" +name = "Information" +sig = "static void Information(Exception exception, string message)" +returns = "void" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[methods]] +parent = "FExStaticLogger" +name = "Warning" +sig = "static void Warning(string message)" +returns = "void" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[methods]] +parent = "FExStaticLogger" +name = "Warning" +sig = "static void Warning(Exception exception)" +returns = "void" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[methods]] +parent = "FExStaticLogger" +name = "Warning" +sig = "static void Warning(Exception exception, string message)" +returns = "void" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[methods]] +parent = "FExStaticLogger" +name = "Error" +sig = "static void Error(string message)" +returns = "void" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[methods]] +parent = "FExStaticLogger" +name = "Error" +sig = "static void Error(Exception exception)" +returns = "void" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[methods]] +parent = "FExStaticLogger" +name = "Error" +sig = "static void Error(Exception exception, string message)" +returns = "void" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[methods]] +parent = "FExStaticLogger" +name = "Critical" +sig = "static void Critical(string message)" +returns = "void" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[methods]] +parent = "FExStaticLogger" +name = "Critical" +sig = "static void Critical(Exception exception)" +returns = "void" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[methods]] +parent = "FExStaticLogger" +name = "Critical" +sig = "static void Critical(Exception exception, string message)" +returns = "void" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[methods]] +parent = "FExStaticLogger" +name = "Configure" +sig = "static void Configure()" +returns = "void" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[methods]] +parent = "FExStaticLogger" +name = "Configure" +sig = "static void Configure(Func loggerFactory)" +returns = "void" +file = "Logging\\FExStaticLogger.cs" +static = true + +[[classes]] +name = "WebRequestParams" +ns = "FEx.Agnostics.Abstractions.Models" +file = "Models\\WebRequestParams.cs" + +[[properties]] +parent = "WebRequestParams" +name = "Credentials" +sig = "ICredentials Credentials { get; set; }" +returns = "ICredentials" +file = "Models\\WebRequestParams.cs" + +[[properties]] +parent = "WebRequestParams" +name = "UserAgent" +sig = "string UserAgent { get; set; }" +returns = "string" +file = "Models\\WebRequestParams.cs" + +[[properties]] +parent = "WebRequestParams" +name = "Headers" +sig = "IDictionary Headers { get; set; }" +returns = "IDictionary" +file = "Models\\WebRequestParams.cs" + +[[properties]] +parent = "WebRequestParams" +name = "Cookies" +sig = "CookieContainer Cookies { get; set; }" +returns = "CookieContainer" +file = "Models\\WebRequestParams.cs" + +[[properties]] +parent = "WebRequestParams" +name = "Method" +sig = "string Method { get; set; }" +returns = "string" +file = "Models\\WebRequestParams.cs" + +[[properties]] +parent = "WebRequestParams" +name = "Timeout" +sig = "int? Timeout { get; set; }" +returns = "int?" +file = "Models\\WebRequestParams.cs" + +[[properties]] +parent = "WebRequestParams" +name = "Pipelined" +sig = "bool? Pipelined { get; set; }" +returns = "bool?" +file = "Models\\WebRequestParams.cs" + +[[properties]] +parent = "WebRequestParams" +name = "KeepAlive" +sig = "bool? KeepAlive { get; set; }" +returns = "bool?" +file = "Models\\WebRequestParams.cs" + +[[properties]] +parent = "WebRequestParams" +name = "ReadWriteTimeout" +sig = "int? ReadWriteTimeout { get; set; }" +returns = "int?" +file = "Models\\WebRequestParams.cs" + +[[properties]] +parent = "WebRequestParams" +name = "Proxy" +sig = "IWebProxy Proxy { get; set; }" +returns = "IWebProxy" +file = "Models\\WebRequestParams.cs" + +[[properties]] +parent = "WebRequestParams" +name = "IsProxyNull" +sig = "bool IsProxyNull { get; set; }" +returns = "bool" +file = "Models\\WebRequestParams.cs" + +[[properties]] +parent = "WebRequestParams" +name = "ServerCertificateValidationCallback" +sig = "RemoteCertificateValidationCallback ServerCertificateValidationCallback { get; set; }" +returns = "RemoteCertificateValidationCallback" +file = "Models\\WebRequestParams.cs" + +[[ctors]] +parent = "WebRequestParams" +sig = "WebRequestParams(IEnumerable cookies = null)" +file = "Models\\WebRequestParams.cs" + +[[classes]] +name = "AttachedException" +ns = "FEx.Agnostics.Abstractions.Utilities" +base = "Exception" +file = "Utilities\\AttachedException.cs" + +[[ctors]] +parent = "AttachedException" +sig = "AttachedException(object sender, StackTrace stackTrace, Exception innerException)" +file = "Utilities\\AttachedException.cs" + +[[ctors]] +parent = "AttachedException" +sig = "AttachedException(string message, StackTrace stackTrace)" +file = "Utilities\\AttachedException.cs" + +[[classes]] +name = "DateTimeDefaults" +ns = "FEx.Agnostics.Abstractions.Utilities" +summary = "Provides set of default datetime values." +file = "Utilities\\DateTimeDefaults.cs" +static = true + +[[properties]] +parent = "DateTimeDefaults" +name = "IsodateMask" +sig = "static string IsodateMask { get; }" +returns = "string" +file = "Utilities\\DateTimeDefaults.cs" +static = true + +[[properties]] +parent = "DateTimeDefaults" +name = "IsotimeMask" +sig = "static string IsotimeMask { get; }" +returns = "string" +file = "Utilities\\DateTimeDefaults.cs" +static = true + +[[properties]] +parent = "DateTimeDefaults" +name = "A4DtimeMask" +sig = "static string A4DtimeMask { get; }" +returns = "string" +file = "Utilities\\DateTimeDefaults.cs" +static = true + +[[properties]] +parent = "DateTimeDefaults" +name = "IsodatetimeMask" +sig = "static string IsodatetimeMask { get; }" +returns = "string" +file = "Utilities\\DateTimeDefaults.cs" +static = true + +[[properties]] +parent = "DateTimeDefaults" +name = "A4DatetimeMask" +sig = "static string A4DatetimeMask { get; }" +returns = "string" +file = "Utilities\\DateTimeDefaults.cs" +static = true + +[[properties]] +parent = "DateTimeDefaults" +name = "DefaultCulture" +sig = "static CultureInfo DefaultCulture { get; }" +returns = "CultureInfo" +file = "Utilities\\DateTimeDefaults.cs" +static = true + +[[properties]] +parent = "DateTimeDefaults" +name = "UnixEpoch" +sig = "static DateTime UnixEpoch { get; }" +returns = "DateTime" +file = "Utilities\\DateTimeDefaults.cs" +static = true + +[[properties]] +parent = "DateTimeDefaults" +name = "CurrentCalendar" +sig = "static Calendar CurrentCalendar { get; }" +returns = "Calendar" +file = "Utilities\\DateTimeDefaults.cs" +static = true + +[[properties]] +parent = "DateTimeDefaults" +name = "CurrentDateTimeFormat" +sig = "static DateTimeFormatInfo CurrentDateTimeFormat { get; }" +returns = "DateTimeFormatInfo" +file = "Utilities\\DateTimeDefaults.cs" +static = true + +[[properties]] +parent = "DateTimeDefaults" +name = "CurrentCalendarWeekRule" +sig = "static CalendarWeekRule CurrentCalendarWeekRule { get; }" +returns = "CalendarWeekRule" +file = "Utilities\\DateTimeDefaults.cs" +static = true + +[[properties]] +parent = "DateTimeDefaults" +name = "CurrentFirstDayOfWeek" +sig = "static DayOfWeek CurrentFirstDayOfWeek { get; }" +returns = "DayOfWeek" +file = "Utilities\\DateTimeDefaults.cs" +static = true + +[[properties]] +parent = "DateTimeDefaults" +name = "SqlMin" +sig = "static DateTime SqlMin { get; }" +returns = "DateTime" +summary = "Gets the SQL minimum allowed date." +file = "Utilities\\DateTimeDefaults.cs" +static = true + +[[properties]] +parent = "DateTimeDefaults" +name = "SqlMax" +sig = "static DateTime SqlMax { get; }" +returns = "DateTime" +summary = "Gets the SQL maximum allowed date." +file = "Utilities\\DateTimeDefaults.cs" +static = true + +[[properties]] +parent = "DateTimeDefaults" +name = "Default" +sig = "static DateTime Default { get; }" +returns = "DateTime" +summary = "Gets the default date." +file = "Utilities\\DateTimeDefaults.cs" +static = true + +[[properties]] +parent = "DateTimeDefaults" +name = "DefaultMinDate" +sig = "static DateTime DefaultMinDate { get; }" +returns = "DateTime" +summary = "Gets the default minimum date." +file = "Utilities\\DateTimeDefaults.cs" +static = true + +[[properties]] +parent = "DateTimeDefaults" +name = "DefaultMaxDate" +sig = "static DateTime DefaultMaxDate { get; }" +returns = "DateTime" +file = "Utilities\\DateTimeDefaults.cs" +static = true + +[[classes]] +name = "DisposableAction" +ns = "FEx.Agnostics.Abstractions.Utilities" +base = "IDisposable" +summary = "Models a disposable action that is guaranteed to be invoked at least on disposal (if not explicitly invoked)." +file = "Utilities\\DisposableAction.cs" + +[[ctors]] +parent = "DisposableAction" +sig = "DisposableAction(Action action)" +summary = "Initializes a new instance of the class." +file = "Utilities\\DisposableAction.cs" + +[[methods]] +parent = "DisposableAction" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +summary = "Releases unmanaged and - optionally - managed resources." +file = "Utilities\\DisposableAction.cs" + +[[methods]] +parent = "DisposableAction" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +summary = "Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources." +file = "Utilities\\DisposableAction.cs" + +[[classes]] +name = "EqualityHelper" +ns = "FEx.Agnostics.Abstractions.Utilities" +file = "Utilities\\EqualityHelper.cs" +static = true + +[[methods]] +parent = "EqualityHelper" +name = "IsEqual" +sig = "static bool IsEqual(ref T field, T value)" +returns = "bool" +file = "Utilities\\EqualityHelper.cs" +static = true + +[[methods]] +parent = "EqualityHelper" +name = "IsNotEqual" +sig = "static bool IsNotEqual(ref T field, T value)" +returns = "bool" +file = "Utilities\\EqualityHelper.cs" +static = true + +[[methods]] +parent = "EqualityHelper" +name = "IsEqual" +sig = "static bool IsEqual(T field, T value)" +returns = "bool" +file = "Utilities\\EqualityHelper.cs" +static = true + +[[methods]] +parent = "EqualityHelper" +name = "IsNotEqual" +sig = "static bool IsNotEqual(T field, T value)" +returns = "bool" +file = "Utilities\\EqualityHelper.cs" +static = true + +[[methods]] +parent = "EqualityHelper" +name = "SetFieldIfChanged" +sig = "static bool SetFieldIfChanged(ref T backingField, T newValue)" +returns = "bool" +file = "Utilities\\EqualityHelper.cs" +static = true + +[[classes]] +name = "FExConversion" +ns = "FEx.Agnostics.Abstractions.Utilities" +file = "Utilities\\FExConversion.cs" +static = true + +[[methods]] +parent = "FExConversion" +name = "Fix" +sig = "static double Fix(double number)" +returns = "double" +summary = "Return the integer portion of a number." +file = "Utilities\\FExConversion.cs" +static = true + +[[classes]] +name = "FExSemaphoreSlim" +ns = "FEx.Agnostics.Abstractions.Utilities" +base = "SemaphoreSlim" +file = "Utilities\\FExSemaphoreSlim.cs" + +[[properties]] +parent = "FExSemaphoreSlim" +name = "IsDisposed" +sig = "bool IsDisposed { get; set; }" +returns = "bool" +file = "Utilities\\FExSemaphoreSlim.cs" + +[[properties]] +parent = "FExSemaphoreSlim" +name = "InitialCount" +sig = "int InitialCount { get; }" +returns = "int" +file = "Utilities\\FExSemaphoreSlim.cs" + +[[properties]] +parent = "FExSemaphoreSlim" +name = "IsIdle" +sig = "bool IsIdle { get; }" +returns = "bool" +file = "Utilities\\FExSemaphoreSlim.cs" + +[[ctors]] +parent = "FExSemaphoreSlim" +sig = "FExSemaphoreSlim(int initialCount = 1, int maxCount = 1)" +file = "Utilities\\FExSemaphoreSlim.cs" + +[[methods]] +parent = "FExSemaphoreSlim" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +file = "Utilities\\FExSemaphoreSlim.cs" + +[[classes]] +name = "FileLengthConverter" +ns = "FEx.Agnostics.Abstractions.Utilities" +file = "Utilities\\FileLengthConverter.cs" +static = true + +[[methods]] +parent = "FileLengthConverter" +name = "ConvertFileLength" +sig = "static (double length, LengthType output) ConvertFileLength(double length, LengthType input, LengthType output, int digits = 3)" +returns = "(double length, LengthType output)" +summary = "Converts the length of the file." +file = "Utilities\\FileLengthConverter.cs" +static = true + +[[methods]] +parent = "FileLengthConverter" +name = "ConvertFileLength" +sig = "static double ConvertFileLength(long size, LengthType input, LengthType output, int digits = 3)" +returns = "double" +summary = "Converts the length of the file." +file = "Utilities\\FileLengthConverter.cs" +static = true + +[[methods]] +parent = "FileLengthConverter" +name = "ConvertFileLength" +sig = "static double ConvertFileLength(FileInfo fi, LengthType output, int digits = 3)" +returns = "double" +summary = "Converts the length of the file." +file = "Utilities\\FileLengthConverter.cs" +static = true + +[[methods]] +parent = "FileLengthConverter" +name = "ConvertFileLengthToString" +sig = "static string ConvertFileLengthToString(double size, LengthType input, LengthType output, int digits = 3)" +returns = "string" +file = "Utilities\\FileLengthConverter.cs" +static = true + +[[methods]] +parent = "FileLengthConverter" +name = "GetOutputLenghtType" +sig = "static LengthType GetOutputLenghtType(long size)" +returns = "LengthType" +file = "Utilities\\FileLengthConverter.cs" +static = true + +[[methods]] +parent = "FileLengthConverter" +name = "GetOutputLenghtType" +sig = "static LengthType GetOutputLenghtType(double size)" +returns = "LengthType" +file = "Utilities\\FileLengthConverter.cs" +static = true + +[[methods]] +parent = "FileLengthConverter" +name = "GetLength" +sig = "static double GetLength(LengthType lengthType)" +returns = "double" +file = "Utilities\\FileLengthConverter.cs" +static = true + +[[methods]] +parent = "FileLengthConverter" +name = "GetLengthType" +sig = "static LengthType GetLengthType(string unitShortcut)" +returns = "LengthType" +file = "Utilities\\FileLengthConverter.cs" +static = true + +[[classes]] +name = "InterlockedBool" +ns = "FEx.Agnostics.Abstractions.Utilities" +file = "Utilities\\InterlockedBool.cs" + +[[properties]] +parent = "InterlockedBool" +name = "Value" +sig = "bool Value { get; set; }" +returns = "bool" +file = "Utilities\\InterlockedBool.cs" + +[[ctors]] +parent = "InterlockedBool" +sig = "InterlockedBool()" +file = "Utilities\\InterlockedBool.cs" + +[[ctors]] +parent = "InterlockedBool" +sig = "InterlockedBool(bool value)" +file = "Utilities\\InterlockedBool.cs" + +[[methods]] +parent = "InterlockedBool" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +file = "Utilities\\InterlockedBool.cs" + +[[methods]] +parent = "InterlockedBool" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +file = "Utilities\\InterlockedBool.cs" + +[[methods]] +parent = "InterlockedBool" +name = "TrySet" +sig = "bool TrySet(bool value)" +returns = "bool" +summary = "This method sets a value" +file = "Utilities\\InterlockedBool.cs" + +[[classes]] +name = "PlatformInfoProvider" +ns = "FEx.Agnostics.Abstractions.Utilities" +summary = "Provides detailed information about the host operating system." +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "IsArm64" +sig = "static bool IsArm64 { get; }" +returns = "bool" +summary = "Indicates whether the operating-system is arm64." +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "Is64Bit" +sig = "static bool Is64Bit { get; }" +returns = "bool" +summary = "Indicates whether the operating-system is 64bit." +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "Is32Bit" +sig = "static bool Is32Bit { get; }" +returns = "bool" +summary = "Indicates whether the operating-system is 32bit." +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "IsUnix" +sig = "static bool IsUnix { get; }" +returns = "bool" +summary = "Indicates whether the operating-system is UNIX." +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "IsWsl" +sig = "static bool IsWsl { get; }" +returns = "bool" +summary = "Indicates whether the current process is running under Windows Subsystem for Linux." +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "Framework" +sig = "static FrameworkName Framework { get; }" +returns = "FrameworkName" +summary = "Indicates the target framework of the current process." +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "Platform" +sig = "static OSPlatformInfo Platform { get; }" +returns = "OSPlatformInfo" +summary = "Indicates the operating-system platform." +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "IsWindows" +sig = "static bool IsWindows { get; }" +returns = "bool" +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "IsMacOS" +sig = "static bool IsMacOS { get; }" +returns = "bool" +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "IsLinux" +sig = "static bool IsLinux { get; }" +returns = "bool" +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "IsAndroid" +sig = "static bool IsAndroid { get; }" +returns = "bool" +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "IsIOS" +sig = "static bool IsIOS { get; }" +returns = "bool" +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "IsBrowser" +sig = "static bool IsBrowser { get; }" +returns = "bool" +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[methods]] +parent = "PlatformInfoProvider" +name = "IsOSPlatform" +sig = "static bool IsOSPlatform(string platform)" +returns = "bool" +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "ProgramBits" +sig = "static SoftwareArchitecture ProgramBits { get; }" +returns = "SoftwareArchitecture" +summary = "Determines if the current application is 32 or 64-bit." +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "OSBits" +sig = "static SoftwareArchitecture OSBits { get; }" +returns = "SoftwareArchitecture" +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "Is64BitOperatingSystem" +sig = "static bool Is64BitOperatingSystem { get; }" +returns = "bool" +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "ProcessorBits" +sig = "static OSProcessorArchitecture ProcessorBits { get; }" +returns = "OSProcessorArchitecture" +summary = "Determines if the current processor is 32 or 64-bit." +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "Edition" +sig = "static OSEdition Edition { get; }" +returns = "OSEdition" +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "EditionString" +sig = "static string EditionString { get; }" +returns = "string" +summary = "Gets the edition of the operating system running on this computer." +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "Name" +sig = "static string Name { get; }" +returns = "string" +summary = "Gets the name of the operating system running on this computer." +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "ServicePack" +sig = "static string ServicePack { get; }" +returns = "string" +summary = "Gets the service pack information of the operating system running on this computer." +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "BuildVersion" +sig = "static int BuildVersion { get; }" +returns = "int" +summary = "Gets the build version number of the operating system running on this computer." +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "Version" +sig = "static Version Version { get; }" +returns = "Version" +summary = "Gets the full version of the operating system running on this computer." +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[properties]] +parent = "PlatformInfoProvider" +name = "InfoString" +sig = "static string InfoString { get; }" +returns = "string" +file = "Utilities\\PlatformInfoProvider.cs" +static = true + +[[classes]] +name = "StringUtilities" +ns = "FEx.Agnostics.Abstractions.Utilities" +summary = "String utility methods for advanced string processing." +file = "Utilities\\StringUtilities.cs" +static = true + +[[properties]] +parent = "StringUtilities" +name = "RomanNumeralsRegex" +sig = "static Regex RomanNumeralsRegex { get; }" +returns = "Regex" +file = "Utilities\\StringUtilities.cs" +static = true + +[[methods]] +parent = "StringUtilities" +name = "WordToProperCase" +sig = "static string WordToProperCase(string word)" +returns = "string" +file = "Utilities\\StringUtilities.cs" +static = true + +[[extensions]] +name = "DealWithRomanNumerals" +returns = "string" +sig = "string DealWithRomanNumerals(this string word)" +file = "Utilities\\StringUtilities.cs" + +[[classes]] +name = "SuppressEventsDisposable" +ns = "FEx.Agnostics.Abstractions.Utilities" +base = "DisposableAction" +file = "Utilities\\SuppressEventsDisposable.cs" + +[[ctors]] +parent = "SuppressEventsDisposable" +sig = "SuppressEventsDisposable(ISuppressEvents suppressedEventSource)" +file = "Utilities\\SuppressEventsDisposable.cs" + +[[ctors]] +parent = "SuppressEventsDisposable" +sig = "SuppressEventsDisposable(ISuppressEvents suppressedEventSource, Action onNoMoreSuppressedEvents)" +file = "Utilities\\SuppressEventsDisposable.cs" + +[[classes]] +name = "WhenResult" +ns = "FEx.Agnostics.Abstractions.Utilities" +file = "Utilities\\WhenResult.cs" + +[[properties]] +parent = "WhenResult" +name = "Result" +sig = "TResult Result { get; set; }" +returns = "TResult" +file = "Utilities\\WhenResult.cs" + +[[properties]] +parent = "WhenResult" +name = "IsResultSet" +sig = "bool IsResultSet { get; }" +returns = "bool" +file = "Utilities\\WhenResult.cs" + +[[properties]] +parent = "WhenResult" +name = "Value" +sig = "T Value { get; }" +returns = "T" +file = "Utilities\\WhenResult.cs" + +[[ctors]] +parent = "WhenResult" +sig = "WhenResult(T value)" +file = "Utilities\\WhenResult.cs" + +[[classes]] +name = "BaseConcurrentList" +ns = "FEx.Agnostics.Abstractions.Collections.Concurrent" +base = "ISuppressEvents" +file = "Collections\\Concurrent\\BaseConcurrentList.cs" + +[[properties]] +parent = "BaseConcurrentList" +name = "Config" +sig = "CollectionEventsConfig Config { get; }" +returns = "CollectionEventsConfig" +file = "Collections\\Concurrent\\BaseConcurrentList.cs" + +[[properties]] +parent = "BaseConcurrentList" +name = "EventsAreSuppressed" +sig = "bool EventsAreSuppressed { get; }" +returns = "bool" +file = "Collections\\Concurrent\\BaseConcurrentList.cs" + +[[ctors]] +parent = "BaseConcurrentList" +sig = "BaseConcurrentList()" +file = "Collections\\Concurrent\\BaseConcurrentList.cs" + +[[methods]] +parent = "BaseConcurrentList" +name = "SuppressEvents" +sig = "SuppressEventsDisposable SuppressEvents()" +returns = "SuppressEventsDisposable" +file = "Collections\\Concurrent\\BaseConcurrentList.cs" + +[[methods]] +parent = "BaseConcurrentList" +name = "OnCountPropertyChanged" +sig = "void OnCountPropertyChanged()" +returns = "void" +file = "Collections\\Concurrent\\BaseConcurrentList.cs" + +[[methods]] +parent = "BaseConcurrentList" +name = "OnIndexerPropertyChanged" +sig = "void OnIndexerPropertyChanged()" +returns = "void" +file = "Collections\\Concurrent\\BaseConcurrentList.cs" + +[[methods]] +parent = "BaseConcurrentList" +name = "OnPropertyChanged" +sig = "void OnPropertyChanged(PropertyChangedEventArgs e)" +returns = "void" +file = "Collections\\Concurrent\\BaseConcurrentList.cs" + +[[methods]] +parent = "BaseConcurrentList" +name = "OnAddToCollection" +sig = "void OnAddToCollection(T item, int index)" +returns = "void" +file = "Collections\\Concurrent\\BaseConcurrentList.cs" + +[[methods]] +parent = "BaseConcurrentList" +name = "OnAddRangeToCollection" +sig = "void OnAddRangeToCollection(IList items, int index)" +returns = "void" +file = "Collections\\Concurrent\\BaseConcurrentList.cs" + +[[methods]] +parent = "BaseConcurrentList" +name = "OnRemoveFromCollection" +sig = "void OnRemoveFromCollection(T item, int index)" +returns = "void" +file = "Collections\\Concurrent\\BaseConcurrentList.cs" + +[[methods]] +parent = "BaseConcurrentList" +name = "OnRemoveFromCollection" +sig = "void OnRemoveFromCollection(IList items, int index)" +returns = "void" +file = "Collections\\Concurrent\\BaseConcurrentList.cs" + +[[methods]] +parent = "BaseConcurrentList" +name = "OnMoveInCollection" +sig = "void OnMoveInCollection(T item, int index, int oldIndex)" +returns = "void" +file = "Collections\\Concurrent\\BaseConcurrentList.cs" + +[[methods]] +parent = "BaseConcurrentList" +name = "OnReplaceInCollection" +sig = "void OnReplaceInCollection(T item, T oldItem, int index)" +returns = "void" +file = "Collections\\Concurrent\\BaseConcurrentList.cs" + +[[methods]] +parent = "BaseConcurrentList" +name = "OnCollectionReset" +sig = "void OnCollectionReset()" +returns = "void" +file = "Collections\\Concurrent\\BaseConcurrentList.cs" + +[[methods]] +parent = "BaseConcurrentList" +name = "OnCollectionChanged" +sig = "void OnCollectionChanged(IList newItems, IList oldItems)" +returns = "void" +file = "Collections\\Concurrent\\BaseConcurrentList.cs" + +[[methods]] +parent = "BaseConcurrentList" +name = "OnCollectionChanged" +sig = "void OnCollectionChanged(NotifyCollectionChangedEventArgs e)" +returns = "void" +file = "Collections\\Concurrent\\BaseConcurrentList.cs" + +[[classes]] +name = "EnumerableExtensions" +ns = "FEx.Agnostics.Abstractions.Extensions.Interop" +file = "Extensions\\Interop\\EnumerableExtensions.cs" +static = true + +[[extensions]] +name = "DistinctBy" +returns = "IEnumerable" +sig = "IEnumerable DistinctBy(this IEnumerable source, Func keySelector)" +summary = "Returns distinct elements from a sequence according to a specified key selector function." +file = "Extensions\\Interop\\EnumerableExtensions.cs" + +[[extensions]] +name = "DistinctBy" +returns = "IEnumerable" +sig = "IEnumerable DistinctBy(this IEnumerable source, Func keySelector, IEqualityComparer comparer)" +file = "Extensions\\Interop\\EnumerableExtensions.cs" [[classes]] name = "DoubleExtensions" @@ -1733,14 +5576,14 @@ static = true [[extensions]] name = "PreciseEquals" -sig = "bool PreciseEquals(this double left, double right, int floatDigits = 7)" returns = "bool" +sig = "bool PreciseEquals(this double left, double right, int floatDigits = 7)" file = "Extensions\\Numericals\\DoubleExtensions.cs" [[extensions]] name = "ToDouble" -sig = "double ToDouble(this string value)" returns = "double" +sig = "double ToDouble(this string value)" file = "Extensions\\Numericals\\DoubleExtensions.cs" [[classes]] @@ -1751,79 +5594,78 @@ static = true [[extensions]] name = "Add" -sig = "int Add(this int source, int value)" returns = "int" +sig = "int Add(this int source, int value)" summary = "Adds the value to source." file = "Extensions\\Numericals\\IntegerExtensions.cs" [[extensions]] name = "IsZero" -sig = "bool IsZero(this int value)" returns = "bool" +sig = "bool IsZero(this int value)" summary = "Indicates that specified value is equal to 0" file = "Extensions\\Numericals\\IntegerExtensions.cs" [[extensions]] name = "IsNotZero" -sig = "bool IsNotZero(this int value)" returns = "bool" +sig = "bool IsNotZero(this int value)" summary = "Indicates that specified value is > than 0" file = "Extensions\\Numericals\\IntegerExtensions.cs" [[extensions]] name = "InRange" -sig = "bool InRange(this int value, int min, int max)" returns = "bool" +sig = "bool InRange(this int value, int min, int max)" summary = "Gets a value indicating if value is between or equal Minimum - Maximum values." file = "Extensions\\Numericals\\IntegerExtensions.cs" [[extensions]] name = "InRange" -sig = "bool InRange(this int value, int min, int max, bool includeMinMaxValues)" returns = "bool" +sig = "bool InRange(this int value, int min, int max, bool includeMinMaxValues)" summary = "Gets a value indicating if value is between (or equal) Minimum - Maximum values." file = "Extensions\\Numericals\\IntegerExtensions.cs" [[extensions]] name = "IsLessThanZero" -sig = "bool IsLessThanZero(this int value)" returns = "bool" +sig = "bool IsLessThanZero(this int value)" summary = "Indicates that specified value is less than zero." file = "Extensions\\Numericals\\IntegerExtensions.cs" [[extensions]] name = "ToStringSafe" -sig = "string ToStringSafe(this int? value)" returns = "string" +sig = "string ToStringSafe(this int? value)" summary = "Converts the integer to a string." file = "Extensions\\Numericals\\IntegerExtensions.cs" [[extensions]] name = "ToStringSafe" -sig = "string ToStringSafe(this int? value, string defaultValue)" returns = "string" +sig = "string ToStringSafe(this int? value, string defaultValue)" summary = "Converts the integer to a string." file = "Extensions\\Numericals\\IntegerExtensions.cs" [[extensions]] name = "ToByteSafe" -sig = "byte ToByteSafe(this int? value)" returns = "byte" +sig = "byte ToByteSafe(this int? value)" summary = "Converts the integer to a byte." file = "Extensions\\Numericals\\IntegerExtensions.cs" [[extensions]] name = "ToByteSafe" -sig = "byte ToByteSafe(this int? value, byte defaultValue)" returns = "byte" +sig = "byte ToByteSafe(this int? value, byte defaultValue)" summary = "Converts the integer to a byte." file = "Extensions\\Numericals\\IntegerExtensions.cs" [[extensions]] name = "ToShort" -sig = "short ToShort(this int value)" returns = "short" -summary = "Converts the integer to a byte." +sig = "short ToShort(this int value)" file = "Extensions\\Numericals\\IntegerExtensions.cs" [[classes]] @@ -1832,22 +5674,67 @@ ns = "FEx.Agnostics.Abstractions.Extensions.Numericals" file = "Extensions\\Numericals\\VBConversion.cs" static = true +[[methods]] +parent = "VBConversion" +name = "Fix" +sig = "static double Fix(double number)" +returns = "double" +summary = "Return the integer portion of a number." +file = "Extensions\\Numericals\\VBConversion.cs" +static = true + [[classes]] name = "UriExtensions" ns = "FEx.Agnostics.Abstractions.Extensions.Web" file = "Extensions\\Web\\UriExtensions.cs" static = true +[[extensions]] +name = "GetWebResponseAsync" +returns = "Task" +sig = "Task GetWebResponseAsync(this Uri url, WebRequestParams pars = null, Stopwatch stopwatch = null)" +file = "Extensions\\Web\\UriExtensions.cs" + +[[extensions]] +name = "CheckForInternetConnectionAsync" +returns = "Task" +sig = "Task CheckForInternetConnectionAsync(this Uri url)" +file = "Extensions\\Web\\UriExtensions.cs" + +[[extensions]] +name = "GetUriFileResponseAsync" +returns = "Task" +sig = "Task GetUriFileResponseAsync(this Uri url, WebRequestParams pars = null, Stopwatch stopwatch = null)" +file = "Extensions\\Web\\UriExtensions.cs" + +[[extensions]] +name = "GetUriHttpResponseAsync" +returns = "Task" +sig = "Task GetUriHttpResponseAsync(this Uri url, WebRequestParams pars = null, Stopwatch stopwatch = null)" +file = "Extensions\\Web\\UriExtensions.cs" + +[[extensions]] +name = "GetUriResponseAsync" +returns = "Task" +sig = "Task GetUriResponseAsync(this Uri url, WebRequestParams pars = null, Stopwatch stopwatch = null)" +file = "Extensions\\Web\\UriExtensions.cs" + [[extensions]] name = "GetHttpRequest" -sig = "HttpWebRequest GetHttpRequest(this Uri url, WebRequestParams pars = null)" returns = "HttpWebRequest" +sig = "HttpWebRequest GetHttpRequest(this Uri url, WebRequestParams pars = null)" file = "Extensions\\Web\\UriExtensions.cs" [[extensions]] name = "GetWebRequest" -sig = "WebRequest GetWebRequest(this Uri url, WebRequestParams pars = null)" returns = "WebRequest" +sig = "WebRequest GetWebRequest(this Uri url, WebRequestParams pars = null)" +file = "Extensions\\Web\\UriExtensions.cs" + +[[extensions]] +name = "TryGetRangeAsync" +returns = "Task<(bool, LengthType)>" +sig = "Task<(bool, LengthType)> TryGetRangeAsync(this Uri url, int rangeFrom, int rangeTo, WebRequestParams pars = null)" file = "Extensions\\Web\\UriExtensions.cs" [[classes]] @@ -1858,9 +5745,17 @@ static = true [[extensions]] name = "PrepareWebClient" +returns = "void" sig = "void PrepareWebClient(this WebClient client, WebRequestParams pars)" +file = "Extensions\\Web\\WebClientExtensions.cs" + +[[methods]] +parent = "WebClientExtensions" +name = "PrepareHttpClient" +sig = "static void PrepareHttpClient(out HttpClient client, WebRequestParams pars, bool resultAsJson = false)" returns = "void" file = "Extensions\\Web\\WebClientExtensions.cs" +static = true [[classes]] name = "WebRequestExtensions" @@ -1870,14 +5765,14 @@ static = true [[extensions]] name = "PrepareRequest" -sig = "void PrepareRequest(this HttpWebRequest req, WebRequestParams pars)" returns = "void" +sig = "void PrepareRequest(this HttpWebRequest req, WebRequestParams pars)" file = "Extensions\\Web\\WebRequestExtensions.cs" [[extensions]] name = "PrepareRequest" -sig = "void PrepareRequest(this WebRequest req, WebRequestParams pars)" returns = "void" +sig = "void PrepareRequest(this WebRequest req, WebRequestParams pars)" file = "Extensions\\Web\\WebRequestExtensions.cs" [[classes]] @@ -1888,14 +5783,14 @@ static = true [[extensions]] name = "GetHttpClientHandler" -sig = "HttpClientHandler GetHttpClientHandler(this WebRequestParams pars)" returns = "HttpClientHandler" +sig = "HttpClientHandler GetHttpClientHandler(this WebRequestParams pars)" file = "Extensions\\Web\\WebRequestParamsExtensions.cs" [[extensions]] name = "Merge" -sig = "WebRequestParams Merge(this WebRequestParams pars, WebRequestParams other)" returns = "WebRequestParams" +sig = "WebRequestParams Merge(this WebRequestParams pars, WebRequestParams other)" file = "Extensions\\Web\\WebRequestParamsExtensions.cs" [[classes]] @@ -1906,209 +5801,44 @@ static = true [[extensions]] name = "GetAllHeaders" -sig = "Dictionary GetAllHeaders(this WebResponse resp)" returns = "Dictionary" +sig = "Dictionary GetAllHeaders(this WebResponse resp)" file = "Extensions\\Web\\WebResponseExtensions.cs" [[extensions]] -name = "GetContentRange" -sig = "ContentRangeHeaderValue GetContentRange(this HttpWebResponse response)" -returns = "ContentRangeHeaderValue" -file = "Extensions\\Web\\WebResponseExtensions.cs" - -[[extensions]] -name = "GetContentRange" -sig = "ContentRangeHeaderValue GetContentRange(this string rangeHeader)" -returns = "ContentRangeHeaderValue" +name = "TryGetRangeAsync" +returns = "Task<(bool, LengthType)>" +sig = "Task<(bool, LengthType)> TryGetRangeAsync(this WebResponse response, int rangeFrom, int rangeTo, WebRequestParams pars = null)" file = "Extensions\\Web\\WebResponseExtensions.cs" [[extensions]] -name = "GetAllHeaders" -sig = "Dictionary GetAllHeaders(this HttpResponseMessage resp)" -returns = "Dictionary" +name = "TryGetRangeAsync" +returns = "Task<(bool, LengthType)>" +sig = "Task<(bool, LengthType)> TryGetRangeAsync(this Uri responseUri, Dictionary responseHeaders, int rangeFrom, int rangeTo, WebRequestParams pars = null)" file = "Extensions\\Web\\WebResponseExtensions.cs" -[[classes]] -name = "AggregatedError" -ns = "FEx.Agnostics.Abstractions.Flow" -base = "Error" -file = "Flow\\AggregatedError.cs" - -[[classes]] -name = "Error" -ns = "FEx.Agnostics.Abstractions.Flow" -base = "IError" -file = "Flow\\Error.cs" - -[[classes]] -name = "Error" -ns = "FEx.Agnostics.Abstractions.Flow" -base = "Error" -file = "Flow\\Error.cs" - -[[classes]] -name = "ExceptionError" -ns = "FEx.Agnostics.Abstractions.Flow" -base = "Error, IExceptionError" -file = "Flow\\ExceptionError.cs" - -[[classes]] -name = "FExErrorEventArgs" -ns = "FEx.Agnostics.Abstractions.Flow" -base = "EventArgs" -file = "Flow\\FExErrorEventArgs.cs" - -[[classes]] -name = "Result" -ns = "FEx.Agnostics.Abstractions.Flow" -base = "ResultBase where TError : class, IError, new()" -file = "Flow\\Result.cs" - -[[classes]] -name = "Result" -ns = "FEx.Agnostics.Abstractions.Flow" -base = "ResultBase, IResult where TError : class, IError, new()" -file = "Flow\\Result.cs" - -[[classes]] -name = "ResultBase" -ns = "FEx.Agnostics.Abstractions.Flow" -base = "IResult where TError : class, IError, new()" -file = "Flow\\ResultBase.cs" - -[[classes]] -name = "EventArgsCache" -ns = "FEx.Agnostics.Abstractions.Helpers" -file = "Helpers\\EventArgsCache.cs" -static = true - -[[classes]] -name = "FExValueTaskHelper" -ns = "FEx.Agnostics.Abstractions.Helpers" -file = "Helpers\\FExValueTaskHelper.cs" -static = true - -[[classes]] -name = "FileSystemHelper" -ns = "FEx.Agnostics.Abstractions.Helpers" -file = "Helpers\\FileSystemHelper.cs" -static = true - -[[classes]] -name = "HashHelper" -ns = "FEx.Agnostics.Abstractions.Helpers" -file = "Helpers\\HashHelper.cs" -static = true - [[extensions]] -name = "GetHashString" -sig = "string GetHashString(this byte[] hash, - bool removeDashes = true, - bool toLower = true, - bool asBase64String = false)" -returns = "string" -file = "Helpers\\HashHelper.cs" - -[[classes]] -name = "LambdaEqualityHelper" -ns = "FEx.Agnostics.Abstractions.Helpers" -file = "Helpers\\LambdaEqualityHelper.cs" - -[[interfaces]] -name = "IAppInfo" -ns = "FEx.Agnostics.Abstractions.Interfaces" -file = "Interfaces\\IAppInfo.cs" - -[[interfaces]] -name = "IAppInfoProvider" -ns = "FEx.Agnostics.Abstractions.Interfaces" -file = "Interfaces\\IAppInfoProvider.cs" - -[[interfaces]] -name = "IAppVersionProvider" -ns = "FEx.Agnostics.Abstractions.Interfaces" -file = "Interfaces\\IAppVersionProvider.cs" - -[[interfaces]] -name = "IAsyncHelper" -ns = "FEx.Agnostics.Abstractions.Interfaces" -file = "Interfaces\\IAsyncHelper.cs" - -[[interfaces]] -name = "IConcurrentList" -ns = "FEx.Agnostics.Abstractions.Interfaces" -file = "Interfaces\\IConcurrentList.cs" - -[[interfaces]] -name = "IExceptionHandlerOptions" -ns = "FEx.Agnostics.Abstractions.Interfaces" -file = "Interfaces\\IExceptionHandlerOptions.cs" - -[[interfaces]] -name = "IFExInitializable" -ns = "FEx.Agnostics.Abstractions.Interfaces" -file = "Interfaces\\IFExInitializable.cs" - -[[interfaces]] -name = "IFExLogger" -ns = "FEx.Agnostics.Abstractions.Interfaces" -summary = "Framework-agnostic logger interface aligned with Microsoft.Extensions.Logging semantics. Provides leveled logging (Trace/Debug/Info/Warning/Error/Critical), structured logging via scopes/labels, and low-level error event hooks." -file = "Interfaces\\IFExLogger.cs" - -[[interfaces]] -name = "IFExMemoryCache" -ns = "FEx.Agnostics.Abstractions.Interfaces" -file = "Interfaces\\IFExMemoryCache.cs" - -[[interfaces]] -name = "IFExNotifyPropertyChanged" -ns = "FEx.Agnostics.Abstractions.Interfaces" -file = "Interfaces\\IFExNotifyPropertyChanged.cs" - -[[interfaces]] -name = "IFExPriorityInitialize" -ns = "FEx.Agnostics.Abstractions.Interfaces" -file = "Interfaces\\IFExPriorityInitialize.cs" - -[[interfaces]] -name = "ILoggerState" -ns = "FEx.Agnostics.Abstractions.Interfaces" -summary = "Represents a mutable dictionary of logging state/labels for structured logging scopes." -file = "Interfaces\\ILoggerState.cs" - -[[interfaces]] -name = "ISuppressEvents" -ns = "FEx.Agnostics.Abstractions.Interfaces" -file = "Interfaces\\ISuppressEvents.cs" - -[[interfaces]] -name = "ISynchronizedAccessService" -ns = "FEx.Agnostics.Abstractions.Interfaces" -file = "Interfaces\\ISynchronizedAccessService.cs" - -[[interfaces]] -name = "ITaskWrapper" -ns = "FEx.Agnostics.Abstractions.Interfaces" -file = "Interfaces\\ITaskWrapper.cs" - -[[interfaces]] -name = "ITaskWrapper" -ns = "FEx.Agnostics.Abstractions.Interfaces" -file = "Interfaces\\ITaskWrapper.cs" +name = "GetContentRange" +returns = "ContentRangeHeaderValue" +sig = "ContentRangeHeaderValue GetContentRange(this HttpWebResponse response)" +file = "Extensions\\Web\\WebResponseExtensions.cs" -[[interfaces]] -name = "ITaskWrapperBase" -ns = "FEx.Agnostics.Abstractions.Interfaces" -file = "Interfaces\\ITaskWrapperBase.cs" +[[extensions]] +name = "GetContentRange" +returns = "ContentRangeHeaderValue" +sig = "ContentRangeHeaderValue GetContentRange(this string rangeHeader)" +file = "Extensions\\Web\\WebResponseExtensions.cs" -[[interfaces]] -name = "ITaskWrapperBase" -ns = "FEx.Agnostics.Abstractions.Interfaces" -file = "Interfaces\\ITaskWrapperBase.cs" +[[extensions]] +name = "GetAllHeaders" +returns = "Dictionary" +sig = "Dictionary GetAllHeaders(this HttpResponseMessage resp)" +file = "Extensions\\Web\\WebResponseExtensions.cs" [[interfaces]] name = "IIndex" ns = "FEx.Agnostics.Abstractions.Interfaces.Collections" +base = "IDictionary" file = "Interfaces\\Collections\\IIndex.cs" [[interfaces]] @@ -2116,14 +5846,85 @@ name = "IMap" ns = "FEx.Agnostics.Abstractions.Interfaces.Collections" file = "Interfaces\\Collections\\IMap.cs" +[[properties]] +parent = "IMap" +name = "ForwardIndex" +sig = "IIndex ForwardIndex { get; }" +returns = "IIndex" +file = "Interfaces\\Collections\\IMap.cs" + +[[properties]] +parent = "IMap" +name = "ReverseIndex" +sig = "IIndex ReverseIndex { get; }" +returns = "IIndex" +file = "Interfaces\\Collections\\IMap.cs" + +[[methods]] +parent = "IMap" +name = "Add" +sig = "void Add(TForwardKey t1, TReverseKey t2)" +returns = "void" +file = "Interfaces\\Collections\\IMap.cs" + +[[methods]] +parent = "IMap" +name = "Clear" +sig = "void Clear()" +returns = "void" +file = "Interfaces\\Collections\\IMap.cs" + +[[methods]] +parent = "IMap" +name = "SetReadOnly" +sig = "void SetReadOnly()" +returns = "void" +file = "Interfaces\\Collections\\IMap.cs" + [[interfaces]] name = "IError" ns = "FEx.Agnostics.Abstractions.Interfaces.Flow" file = "Interfaces\\Flow\\IError.cs" +[[properties]] +parent = "IError" +name = "Message" +sig = "string Message { get; }" +returns = "string" +file = "Interfaces\\Flow\\IError.cs" + +[[properties]] +parent = "IError" +name = "RootError" +sig = "IError RootError { get; }" +returns = "IError" +file = "Interfaces\\Flow\\IError.cs" + +[[properties]] +parent = "IError" +name = "InnerError" +sig = "IError InnerError { get; }" +returns = "IError" +file = "Interfaces\\Flow\\IError.cs" + +[[methods]] +parent = "IError" +name = "SetInnerError" +sig = "void SetInnerError(IError innerError)" +returns = "void" +file = "Interfaces\\Flow\\IError.cs" + [[interfaces]] name = "IExceptionError" ns = "FEx.Agnostics.Abstractions.Interfaces.Flow" +base = "IStackError" +file = "Interfaces\\Flow\\IExceptionError.cs" + +[[properties]] +parent = "IExceptionError" +name = "Exception" +sig = "Exception Exception { get; }" +returns = "Exception" file = "Interfaces\\Flow\\IExceptionError.cs" [[interfaces]] @@ -2131,139 +5932,265 @@ name = "IResult" ns = "FEx.Agnostics.Abstractions.Interfaces.Flow" file = "Interfaces\\Flow\\IResult.cs" +[[properties]] +parent = "IResult" +name = "IsSuccess" +sig = "bool IsSuccess { get; }" +returns = "bool" +file = "Interfaces\\Flow\\IResult.cs" + +[[properties]] +parent = "IResult" +name = "IsFailure" +sig = "bool IsFailure { get; }" +returns = "bool" +file = "Interfaces\\Flow\\IResult.cs" + [[interfaces]] name = "IResult" ns = "FEx.Agnostics.Abstractions.Interfaces.Flow" +base = "IResult" +file = "Interfaces\\Flow\\IResult.cs" + +[[properties]] +parent = "IResult" +name = "Error" +sig = "TError Error { get; }" +returns = "TError" file = "Interfaces\\Flow\\IResult.cs" [[interfaces]] name = "IResult" ns = "FEx.Agnostics.Abstractions.Interfaces.Flow" +base = "IResult" +file = "Interfaces\\Flow\\IResult.cs" + +[[properties]] +parent = "IResult" +name = "Data" +sig = "TData Data { get; }" +returns = "TData" +file = "Interfaces\\Flow\\IResult.cs" + +[[methods]] +parent = "IResult" +name = "TryGetData" +sig = "bool TryGetData(out TData data)" +returns = "bool" file = "Interfaces\\Flow\\IResult.cs" [[interfaces]] name = "IStackError" ns = "FEx.Agnostics.Abstractions.Interfaces.Flow" +base = "IError" file = "Interfaces\\Flow\\IStackError.cs" -[[classes]] -name = "SpecialDirectory" -ns = "FEx.Agnostics.Abstractions.IO" -file = "IO\\SpecialDirectory.cs" +[[properties]] +parent = "IStackError" +name = "StackTrace" +sig = "string StackTrace { get; }" +returns = "string" +file = "Interfaces\\Flow\\IStackError.cs" -[[classes]] -name = "FExDebugLogger" -ns = "FEx.Agnostics.Abstractions.Logging" -base = "IFExLogger" -summary = "Simple debug console logger implementation (no structured logging support)." -file = "Logging\\FExDebugLogger.cs" +[[properties]] +parent = "IStackError" +name = "RootErrorStackTrace" +sig = "string RootErrorStackTrace { get; }" +returns = "string" +file = "Interfaces\\Flow\\IStackError.cs" -[[classes]] -name = "FExStaticLogger" -ns = "FEx.Agnostics.Abstractions.Logging" -base = "FExInitializable" -file = "Logging\\FExStaticLogger.cs" +[[enums]] +name = "OSPlatformInfo" +ns = "FEx.Agnostics.Abstractions.Utilities.OS" +file = "Utilities\\OS\\OSPlatformInfo.cs" -[[classes]] -name = "WebRequestParams" -ns = "FEx.Agnostics.Abstractions.Models" -file = "Models\\WebRequestParams.cs" +[[enums]] +name = "OSProduct" +ns = "FEx.Agnostics.Abstractions.Utilities.OS" +file = "Utilities\\OS\\OSProduct.cs" [[classes]] -name = "AttachedException" -ns = "FEx.Agnostics.Abstractions.Utilities" -base = "Exception" -file = "Utilities\\AttachedException.cs" +name = "OSVersion" +ns = "FEx.Agnostics.Abstractions.Utilities.OS" +base = "IEquatable" +file = "Utilities\\OS\\OSVersion.cs" -[[classes]] -name = "DateTimeDefaults" -ns = "FEx.Agnostics.Abstractions.Utilities" -summary = "Provides set of default datetime values." -file = "Utilities\\DateTimeDefaults.cs" -static = true +[[ctors]] +parent = "OSVersion" +sig = "OSVersion(int majorVersion, int minorVersion, int productType)" +file = "Utilities\\OS\\OSVersion.cs" -[[classes]] -name = "DisposableAction" -ns = "FEx.Agnostics.Abstractions.Utilities" -base = "IDisposable" -summary = "Models a disposable action that is guaranteed to be invoked at least on disposal (if not explicitly invoked)." -file = "Utilities\\DisposableAction.cs" +[[methods]] +parent = "OSVersion" +name = "Equals" +sig = "bool Equals(OSVersion other)" +returns = "bool" +file = "Utilities\\OS\\OSVersion.cs" + +[[methods]] +parent = "OSVersion" +name = "ToString" +sig = "string ToString()" +returns = "string" +file = "Utilities\\OS\\OSVersion.cs" + +[[methods]] +parent = "OSVersion" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +file = "Utilities\\OS\\OSVersion.cs" + +[[methods]] +parent = "OSVersion" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +file = "Utilities\\OS\\OSVersion.cs" [[classes]] -name = "EqualityHelper" -ns = "FEx.Agnostics.Abstractions.Utilities" -file = "Utilities\\EqualityHelper.cs" -static = true +name = "OSVersionInfoEx" +ns = "FEx.Agnostics.Abstractions.Utilities.OS" +file = "Utilities\\OS\\OSVersionInfoEx.cs" [[classes]] -name = "FExConversion" -ns = "FEx.Agnostics.Abstractions.Utilities" -file = "Utilities\\FExConversion.cs" -static = true +name = "ProcessorInfoUnion" +ns = "FEx.Agnostics.Abstractions.Utilities.OS" +file = "Utilities\\OS\\ProcessorInfoUnion.cs" [[classes]] -name = "FExSemaphoreSlim" -ns = "FEx.Agnostics.Abstractions.Utilities" -base = "SemaphoreSlim" -file = "Utilities\\FExSemaphoreSlim.cs" +name = "SystemInfo" +ns = "FEx.Agnostics.Abstractions.Utilities.OS" +file = "Utilities\\OS\\SystemInfo.cs" [[classes]] -name = "FileLengthConverter" -ns = "FEx.Agnostics.Abstractions.Utilities" -file = "Utilities\\FileLengthConverter.cs" +name = "ArrayExtensions" +ns = "FEx.Agnostics.Abstractions.Extensions.Collections.Arrays" +file = "Extensions\\Collections\\Arrays\\ArrayExtensions.cs" static = true -[[classes]] -name = "InterlockedBool" -ns = "FEx.Agnostics.Abstractions.Utilities" -file = "Utilities\\InterlockedBool.cs" +[[extensions]] +name = "WithinIndex" +returns = "bool" +sig = "bool WithinIndex(this Array source, int index)" +summary = "Check if the index is within the array" +file = "Extensions\\Collections\\Arrays\\ArrayExtensions.cs" + +[[extensions]] +name = "IndexOf" +returns = "int" +sig = "int IndexOf(this Array source, object value)" +summary = "Indexes the of." +file = "Extensions\\Collections\\Arrays\\ArrayExtensions.cs" [[classes]] -name = "PlatformInfoProvider" -ns = "FEx.Agnostics.Abstractions.Utilities" -summary = "Provides detailed information about the host operating system." -file = "Utilities\\PlatformInfoProvider.cs" +name = "ReadOnlyDictionaryExtensions" +ns = "FEx.Agnostics.Abstractions.Extensions.Collections.Dictionaries" +summary = "IReadOnlyDictionary extensions class." +file = "Extensions\\Collections\\Dictionaries\\ReadOnlyDictionaryExtensions.cs" static = true +[[extensions]] +name = "TryGetReadOnlyKeyValue" +returns = "TValue" +sig = "TValue TryGetReadOnlyKeyValue(this IReadOnlyDictionary dictionary, TKey key, TValue fallback = default)" +file = "Extensions\\Collections\\Dictionaries\\ReadOnlyDictionaryExtensions.cs" + +[[extensions]] +name = "GetReadOnlyValue" +returns = "(bool isSuccess, TV value)" +sig = "(bool isSuccess, TV value) GetReadOnlyValue(this IReadOnlyDictionary dictionary, TK key)" +file = "Extensions\\Collections\\Dictionaries\\ReadOnlyDictionaryExtensions.cs" + [[classes]] -name = "StringUtilities" -ns = "FEx.Agnostics.Abstractions.Utilities" -summary = "String utility methods for advanced string processing." -file = "Utilities\\StringUtilities.cs" +name = "ListExtensions" +ns = "FEx.Agnostics.Abstractions.Extensions.Collections.Lists" +summary = "Extensions for the IList interface." +file = "Extensions\\Collections\\Lists\\ListExtensions.cs" static = true [[extensions]] -name = "DealWithRomanNumerals" -sig = "string DealWithRomanNumerals(this string word)" -returns = "string" -file = "Utilities\\StringUtilities.cs" +name = "IsNotEmpty" +returns = "bool" +sig = "bool IsNotEmpty(this IList source)" +summary = "Gets a value indicating if the collection contains data." +file = "Extensions\\Collections\\Lists\\ListExtensions.cs" -[[classes]] -name = "SuppressEventsDisposable" -ns = "FEx.Agnostics.Abstractions.Utilities" -base = "DisposableAction" -file = "Utilities\\SuppressEventsDisposable.cs" +[[extensions]] +name = "IsNullOrEmptyList" +returns = "bool" +sig = "bool IsNullOrEmptyList(this IList source)" +summary = "Gets a value indicating if the collection contains data." +file = "Extensions\\Collections\\Lists\\ListExtensions.cs" -[[classes]] -name = "WhenResult" -ns = "FEx.Agnostics.Abstractions.Utilities" -file = "Utilities\\WhenResult.cs" +[[extensions]] +name = "IsNotNullOrEmptyList" +returns = "bool" +sig = "bool IsNotNullOrEmptyList(this IList source)" +summary = "Determines whether [is not null neither is empty]." +file = "Extensions\\Collections\\Lists\\ListExtensions.cs" -[[enums]] -name = "OSPlatformInfo" -ns = "FEx.Agnostics.Abstractions.Utilities.OS" -file = "Utilities\\OS\\OSPlatformInfo.cs" +[[extensions]] +name = "ToReadOnly" +returns = "ReadOnlyCollection" +sig = "ReadOnlyCollection ToReadOnly(this IList source)" +summary = "Converts to a readonly collection." +file = "Extensions\\Collections\\Lists\\ListExtensions.cs" -[[enums]] -name = "OSProduct" -ns = "FEx.Agnostics.Abstractions.Utilities.OS" -file = "Utilities\\OS\\OSProduct.cs" +[[extensions]] +name = "RemoveFromListWhere" +returns = "bool" +sig = "bool RemoveFromListWhere(this ICollection source, Func predicate)" +file = "Extensions\\Collections\\Lists\\ListExtensions.cs" -[[classes]] -name = "OSVersion" -ns = "FEx.Agnostics.Abstractions.Utilities.OS" -base = "IEquatable" -file = "Utilities\\OS\\OSVersion.cs" +[[extensions]] +name = "GetRange" +returns = "List" +sig = "List GetRange(this IList sourceList, int index, int count)" +file = "Extensions\\Collections\\Lists\\ListExtensions.cs" + +[[extensions]] +name = "SplitList" +returns = "IList>" +sig = "IList> SplitList(this IList sourceList, int chunkSize)" +file = "Extensions\\Collections\\Lists\\ListExtensions.cs" + +[[extensions]] +name = "SyncWithItem" +returns = "void" +sig = "void SyncWithItem(this IList sourceList, T item, Action syncAction = null)" +file = "Extensions\\Collections\\Lists\\ListExtensions.cs" + +[[extensions]] +name = "CountEqualItems" +returns = "int" +sig = "int CountEqualItems(this IList listA, IList listB)" +file = "Extensions\\Collections\\Lists\\ListExtensions.cs" + +[[extensions]] +name = "AddRangeToList" +returns = "void" +sig = "void AddRangeToList(this TColl source, IEnumerable items)" +file = "Extensions\\Collections\\Lists\\ListExtensions.cs" + +[[extensions]] +name = "Move" +returns = "void" +sig = "void Move(this IList source, int oldIndex, int newIndex)" +file = "Extensions\\Collections\\Lists\\ListExtensions.cs" + +[[extensions]] +name = "SyncWith" +returns = "bool" +sig = "bool SyncWith(this IList sourceList, IList syncedList, Func equalityComparator, Action syncAction = null)" +summary = "Synchronizes two lists in one way mode." +file = "Extensions\\Collections\\Lists\\ListExtensions.cs" + +[[extensions]] +name = "SyncWith" +returns = "bool" +sig = "bool SyncWith(this IList sourceList, IList syncedList, Action syncAction = null)" +file = "Extensions\\Collections\\Lists\\ListExtensions.cs" [[enums]] name = "OSEdition" diff --git a/.api-surface/FEx/Agnostics.TestMocks.toml b/.api-surface/FEx/Agnostics.TestMocks.toml index ff5d0328..f7380525 100644 --- a/.api-surface/FEx/Agnostics.TestMocks.toml +++ b/.api-surface/FEx/Agnostics.TestMocks.toml @@ -7,26 +7,108 @@ name = "TestBase" ns = "FEx.Agnostics.TestMocks" file = "TestBase.cs" +[[ctors]] +parent = "TestBase" +sig = "TestBase()" +file = "TestBase.cs" + +[[methods]] +parent = "TestBase" +name = "FormatMessage" +sig = "string FormatMessage(string format, params object[] args)" +returns = "string" +file = "TestBase.cs" + [[classes]] name = "UniqueRandomGenerator" ns = "FEx.Agnostics.TestMocks.Helpers" file = "Helpers\\UniqueRandomGenerator.cs" +[[ctors]] +parent = "UniqueRandomGenerator" +sig = "UniqueRandomGenerator()" +file = "Helpers\\UniqueRandomGenerator.cs" + +[[ctors]] +parent = "UniqueRandomGenerator" +sig = "UniqueRandomGenerator(int minValue, int maxValue)" +file = "Helpers\\UniqueRandomGenerator.cs" + +[[methods]] +parent = "UniqueRandomGenerator" +name = "GenerateUniqueRandomInteger" +sig = "int GenerateUniqueRandomInteger()" +returns = "int" +file = "Helpers\\UniqueRandomGenerator.cs" + [[classes]] name = "XUnitFExLoggerHelper" ns = "FEx.Agnostics.TestMocks.Logging" file = "Logging\\XUnitFExLoggerHelper.cs" static = true +[[methods]] +parent = "XUnitFExLoggerHelper" +name = "CreateMockLogger" +sig = "static IFExLogger CreateMockLogger(ITestOutputHelper output)" +returns = "IFExLogger" +file = "Logging\\XUnitFExLoggerHelper.cs" +static = true + [[classes]] name = "XUnitLogger" ns = "FEx.Agnostics.TestMocks.Logging" base = "ILogger" file = "Logging\\XUnitLogger.cs" +[[ctors]] +parent = "XUnitLogger" +sig = "XUnitLogger(ITestOutputHelper output, string categoryName)" +file = "Logging\\XUnitLogger.cs" + +[[methods]] +parent = "XUnitLogger" +name = "BeginScope" +sig = "IDisposable BeginScope(TState state)" +returns = "IDisposable" +file = "Logging\\XUnitLogger.cs" + +[[methods]] +parent = "XUnitLogger" +name = "IsEnabled" +sig = "bool IsEnabled(LogLevel logLevel)" +returns = "bool" +file = "Logging\\XUnitLogger.cs" + +[[methods]] +parent = "XUnitLogger" +name = "Log" +sig = "void Log(LogLevel logLevel, EventId eventId, TState state, Exception exception, Func formatter)" +returns = "void" +file = "Logging\\XUnitLogger.cs" + [[classes]] name = "XUnitLoggerProvider" ns = "FEx.Agnostics.TestMocks.Logging" base = "ILoggerProvider" file = "Logging\\XUnitLoggerProvider.cs" +[[ctors]] +parent = "XUnitLoggerProvider" +sig = "XUnitLoggerProvider(ITestOutputHelper output)" +file = "Logging\\XUnitLoggerProvider.cs" + +[[methods]] +parent = "XUnitLoggerProvider" +name = "CreateLogger" +sig = "ILogger CreateLogger(string categoryName)" +returns = "ILogger" +file = "Logging\\XUnitLoggerProvider.cs" + +[[methods]] +parent = "XUnitLoggerProvider" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Logging\\XUnitLoggerProvider.cs" + diff --git a/.api-surface/FEx/Agnostics.toml b/.api-surface/FEx/Agnostics.toml index a14e9dcc..a059b88a 100644 --- a/.api-surface/FEx/Agnostics.toml +++ b/.api-surface/FEx/Agnostics.toml @@ -8,54 +8,131 @@ ns = "FEx.Agnostics.BaseObjects" base = "PropertyChangeAware, IFExNotifyPropertyChanged" file = "BaseObjects\\NotifyPropertyChanged.cs" +[[methods]] +parent = "NotifyPropertyChanged" +name = "OnPropertyChanged" +sig = "void OnPropertyChanged([CallerMemberName] string propertyName = null)" +returns = "void" +file = "BaseObjects\\NotifyPropertyChanged.cs" + [[classes]] name = "PropertyChangeAware" ns = "FEx.Agnostics.BaseObjects" file = "BaseObjects\\PropertyChangeAware.cs" +[[methods]] +parent = "PropertyChangeAware" +name = "OnPropertiesChanged" +sig = "void OnPropertiesChanged(params string[] propertyNames)" +returns = "void" +file = "BaseObjects\\PropertyChangeAware.cs" + +[[methods]] +parent = "PropertyChangeAware" +name = "SetProperty" +sig = "bool SetProperty(ref TRet backingField, TRet newValue, Action onPropertyChanged = null, [CallerMemberName] string propertyName = null)" +returns = "bool" +file = "BaseObjects\\PropertyChangeAware.cs" + +[[methods]] +parent = "PropertyChangeAware" +name = "OnPropertySet" +sig = "void OnPropertySet(T oldValue, T newValue, string propertyName)" +returns = "void" +file = "BaseObjects\\PropertyChangeAware.cs" + +[[methods]] +parent = "PropertyChangeAware" +name = "OnPropertyChanged" +sig = "void OnPropertyChanged([CallerMemberName] string propertyName = null)" +returns = "void" +file = "BaseObjects\\PropertyChangeAware.cs" + [[classes]] name = "PaginatedList" ns = "FEx.Agnostics.Collections" file = "Collections\\PaginatedList.cs" +[[properties]] +parent = "PaginatedList" +name = "Empty" +sig = "static PaginatedList Empty { get; }" +returns = "PaginatedList" +file = "Collections\\PaginatedList.cs" +static = true + +[[properties]] +parent = "PaginatedList" +name = "Items" +sig = "IList Items { get; }" +returns = "IList" +file = "Collections\\PaginatedList.cs" + +[[properties]] +parent = "PaginatedList" +name = "PageIndex" +sig = "int PageIndex { get; }" +returns = "int" +file = "Collections\\PaginatedList.cs" + +[[properties]] +parent = "PaginatedList" +name = "TotalPages" +sig = "int TotalPages { get; }" +returns = "int" +file = "Collections\\PaginatedList.cs" + +[[properties]] +parent = "PaginatedList" +name = "TotalItemsCount" +sig = "int TotalItemsCount { get; }" +returns = "int" +file = "Collections\\PaginatedList.cs" + +[[properties]] +parent = "PaginatedList" +name = "HasPreviousPage" +sig = "bool HasPreviousPage { get; }" +returns = "bool" +file = "Collections\\PaginatedList.cs" + +[[properties]] +parent = "PaginatedList" +name = "HasNextPage" +sig = "bool HasNextPage { get; }" +returns = "bool" +file = "Collections\\PaginatedList.cs" + +[[ctors]] +parent = "PaginatedList" +sig = "PaginatedList(IList items, int totalItemsCount, int pageIndex, int totalPages)" +file = "Collections\\PaginatedList.cs" + [[classes]] name = "SummarizedPaginatedList" ns = "FEx.Agnostics.Collections" base = "PaginatedList" file = "Collections\\SummarizedPaginatedList.cs" -[[classes]] -name = "CollectionDebugView" -ns = "FEx.Agnostics.Collections.Concurrent" -file = "Collections\\Concurrent\\CollectionDebugView.cs" - -[[classes]] -name = "ConcurrentList" -ns = "FEx.Agnostics.Collections.Concurrent" -base = "BaseConcurrentList, IConcurrentList" -file = "Collections\\Concurrent\\ConcurrentList.cs" - -[[classes]] -name = "ConcurrentList" -ns = "FEx.Agnostics.Collections.Concurrent" -file = "Collections\\Concurrent\\ConcurrentList.Impl.cs" - -[[classes]] -name = "ConcurrentSortableList" -ns = "FEx.Agnostics.Collections.Concurrent" -base = "ConcurrentList where T : IComparable" -file = "Collections\\Concurrent\\ConcurrentSortableList.cs" +[[properties]] +parent = "SummarizedPaginatedList" +name = "Empty" +sig = "static SummarizedPaginatedList Empty { get; }" +returns = "SummarizedPaginatedList" +file = "Collections\\SummarizedPaginatedList.cs" +static = true -[[classes]] -name = "FExMemoryCache" -ns = "FEx.Agnostics.Collections.Concurrent" -base = "IFExMemoryCache, IDictionary, IDictionary" -file = "Collections\\Concurrent\\FExMemoryCache.cs" +[[properties]] +parent = "SummarizedPaginatedList" +name = "Summary" +sig = "TSum Summary { get; }" +returns = "TSum" +file = "Collections\\SummarizedPaginatedList.cs" -[[classes]] -name = "ListDebugView" -ns = "FEx.Agnostics.Collections.Concurrent" -file = "Collections\\Concurrent\\ListDebugView.cs" +[[ctors]] +parent = "SummarizedPaginatedList" +sig = "SummarizedPaginatedList(IList items, int totalItemsCount, int pageIndex, int totalPages, Func, TSum> sumFunc)" +file = "Collections\\SummarizedPaginatedList.cs" [[classes]] name = "AlphanumComparatorFast" @@ -63,18 +140,76 @@ ns = "FEx.Agnostics.Comparers" base = "IComparer, IEqualityComparer" file = "Comparers\\AlphanumComparatorFast.cs" +[[methods]] +parent = "AlphanumComparatorFast" +name = "Compare" +sig = "int Compare(string s1, string s2)" +returns = "int" +file = "Comparers\\AlphanumComparatorFast.cs" + +[[methods]] +parent = "AlphanumComparatorFast" +name = "Equals" +sig = "bool Equals(string x, string y)" +returns = "bool" +file = "Comparers\\AlphanumComparatorFast.cs" + +[[methods]] +parent = "AlphanumComparatorFast" +name = "GetHashCode" +sig = "int GetHashCode(string obj)" +returns = "int" +file = "Comparers\\AlphanumComparatorFast.cs" + +[[methods]] +parent = "AlphanumComparatorFast" +name = "Compare" +sig = "static int Compare(string s1, string s2, StringComparison comparisonType)" +returns = "int" +file = "Comparers\\AlphanumComparatorFast.cs" +static = true + [[classes]] name = "NonSpaceIgnoringStringComparer" ns = "FEx.Agnostics.Comparers" base = "IEqualityComparer" file = "Comparers\\NonSpaceIgnoringStringComparer.cs" +[[methods]] +parent = "NonSpaceIgnoringStringComparer" +name = "Equals" +sig = "bool Equals(string x, string y)" +returns = "bool" +file = "Comparers\\NonSpaceIgnoringStringComparer.cs" + +[[methods]] +parent = "NonSpaceIgnoringStringComparer" +name = "GetHashCode" +sig = "int GetHashCode(string obj)" +returns = "int" +file = "Comparers\\NonSpaceIgnoringStringComparer.cs" + [[classes]] name = "FExException" ns = "FEx.Agnostics.Exceptions" base = "Exception" file = "Exceptions\\FExException.cs" +[[ctors]] +parent = "FExException" +sig = "FExException()" +file = "Exceptions\\FExException.cs" + +[[ctors]] +parent = "FExException" +sig = "FExException(string message)" +file = "Exceptions\\FExException.cs" + +[[ctors]] +parent = "FExException" +sig = "FExException(string message, Exception innerException)" +file = "Exceptions\\FExException.cs" + [[classes]] name = "AsyncReaderWriterLockSlimExtension" ns = "FEx.Agnostics.Extensions" @@ -82,54 +217,75 @@ summary = "Contains extension methods for ." file = "Extensions\\AsyncReaderWriterLockSlimExtension.cs" static = true -[[interfaces]] -name = "IDisposableLock" -ns = "FEx.Agnostics.Extensions" -summary = "Downgrades the lock from write mode to read mode." -file = "Extensions\\AsyncReaderWriterLockSlimExtension.cs" - [[extensions]] name = "GetReadLock" -sig = "IDisposableLock GetReadLock(this AsyncReaderWriterLockSlim lockInstance, - CancellationToken cancellationToken = default)" returns = "IDisposableLock" +sig = "IDisposableLock GetReadLock(this AsyncReaderWriterLockSlim lockInstance, CancellationToken cancellationToken = default)" summary = "Enters the lock in read mode." file = "Extensions\\AsyncReaderWriterLockSlimExtension.cs" +[[extensions]] +name = "GetReadLockAsync" +returns = "Task" +sig = "Task GetReadLockAsync(this AsyncReaderWriterLockSlim lockInstance, CancellationToken cancellationToken = default)" +summary = "Asynchronously enters the lock in read mode and returns a that will release the lock when disposed." +file = "Extensions\\AsyncReaderWriterLockSlimExtension.cs" + [[extensions]] name = "TryGetReadLock" -sig = "IDisposableLock TryGetReadLock(this AsyncReaderWriterLockSlim lockInstance, - int millisecondsTimeout, - CancellationToken cancellationToken = default)" returns = "IDisposableLock" +sig = "IDisposableLock TryGetReadLock(this AsyncReaderWriterLockSlim lockInstance, int millisecondsTimeout, CancellationToken cancellationToken = default)" summary = "Tries to enter the lock in read mode, with an optional integer time-out." file = "Extensions\\AsyncReaderWriterLockSlimExtension.cs" +[[extensions]] +name = "TryGetReadLockAsync" +returns = "Task" +sig = "Task TryGetReadLockAsync(this AsyncReaderWriterLockSlim lockInstance, int millisecondsTimeout, CancellationToken cancellationToken = default)" +summary = "Tries to asynchronously enter the lock in read mode, with an optional integer time-out." +file = "Extensions\\AsyncReaderWriterLockSlimExtension.cs" + [[extensions]] name = "GetWriteLock" -sig = "IDisposableLock GetWriteLock(this AsyncReaderWriterLockSlim lockInstance, - CancellationToken cancellationToken = default)" returns = "IDisposableLock" +sig = "IDisposableLock GetWriteLock(this AsyncReaderWriterLockSlim lockInstance, CancellationToken cancellationToken = default)" summary = "Enters the lock in write mode." file = "Extensions\\AsyncReaderWriterLockSlimExtension.cs" +[[extensions]] +name = "GetWriteLockAsync" +returns = "Task" +sig = "Task GetWriteLockAsync(this AsyncReaderWriterLockSlim lockInstance, CancellationToken cancellationToken = default)" +summary = "Asynchronously enters the lock in write mode." +file = "Extensions\\AsyncReaderWriterLockSlimExtension.cs" + [[extensions]] name = "TryGetWriteLock" -sig = "IDisposableLock TryGetWriteLock(this AsyncReaderWriterLockSlim lockInstance, - int millisecondsTimeout, - CancellationToken cancellationToken = default)" returns = "IDisposableLock" +sig = "IDisposableLock TryGetWriteLock(this AsyncReaderWriterLockSlim lockInstance, int millisecondsTimeout, CancellationToken cancellationToken = default)" summary = "Tries to enter the lock in write mode, with an optional integer time-out." file = "Extensions\\AsyncReaderWriterLockSlimExtension.cs" +[[extensions]] +name = "TryGetWriteLockAsync" +returns = "Task" +sig = "Task TryGetWriteLockAsync(this AsyncReaderWriterLockSlim lockInstance, int millisecondsTimeout, CancellationToken cancellationToken = default)" +summary = "Tries to asynchronously enter the lock in write mode, with an optional integer time-out." +file = "Extensions\\AsyncReaderWriterLockSlimExtension.cs" + [[extensions]] name = "DowngradeWriteLockToReadLock" -sig = "void DowngradeWriteLockToReadLock(this AsyncReaderWriterLockSlim lockInstance, - IDisposableLock readLock)" returns = "void" +sig = "void DowngradeWriteLockToReadLock(this AsyncReaderWriterLockSlim lockInstance, IDisposableLock readLock)" summary = "Downgrades the lock from write mode to read mode." file = "Extensions\\AsyncReaderWriterLockSlimExtension.cs" +[[interfaces]] +name = "IDisposableLock" +ns = "FEx.Agnostics.Extensions" +base = "IDisposable" +file = "Extensions\\AsyncReaderWriterLockSlimExtension.cs" + [[classes]] name = "EnumerableExtensions" ns = "FEx.Agnostics.Extensions" @@ -138,14 +294,38 @@ static = true [[extensions]] name = "OrderAlphanumBy" -sig = "IOrderedEnumerable OrderAlphanumBy(this IEnumerable source)" returns = "IOrderedEnumerable" +sig = "IOrderedEnumerable OrderAlphanumBy(this IEnumerable source)" +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "OrderAlphanumBy" +returns = "IOrderedEnumerable" +sig = "IOrderedEnumerable OrderAlphanumBy(this IEnumerable source, Func keySelector)" file = "Extensions\\EnumerableExtensions.cs" [[extensions]] name = "OrderAlphanumByDescending" -sig = "IOrderedEnumerable OrderAlphanumByDescending(this IEnumerable source)" returns = "IOrderedEnumerable" +sig = "IOrderedEnumerable OrderAlphanumByDescending(this IEnumerable source)" +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "OrderAlphanumByDescending" +returns = "IOrderedEnumerable" +sig = "IOrderedEnumerable OrderAlphanumByDescending( this IEnumerable source, Func keySelector)" +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "ToConcurrentList" +returns = "ConcurrentList" +sig = "ConcurrentList ToConcurrentList(this IEnumerable source)" +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "ToConcurrentSortableList" +returns = "ConcurrentSortableList" +sig = "ConcurrentSortableList ToConcurrentSortableList(this IEnumerable source)" file = "Extensions\\EnumerableExtensions.cs" [[classes]] @@ -154,12 +334,36 @@ ns = "FEx.Agnostics.Extensions" file = "Extensions\\ListExtensions.cs" static = true +[[extensions]] +name = "MakePaginatedList" +returns = "PaginatedList" +sig = "PaginatedList MakePaginatedList(this IList items, int itemsPerPage, int page)" +file = "Extensions\\ListExtensions.cs" + [[classes]] name = "ColorHelper" ns = "FEx.Agnostics.Helpers" file = "Helpers\\ColorHelper.cs" static = true +[[methods]] +parent = "ColorHelper" +name = "FromArgbString" +sig = "static Color FromArgbString(string colorcode)" +returns = "Color" +summary = "Gets from ARGB string." +file = "Helpers\\ColorHelper.cs" +static = true + +[[methods]] +parent = "ColorHelper" +name = "FromRgbString" +sig = "static Color FromRgbString(string colorcode)" +returns = "Color" +summary = "Froms the RGB string." +file = "Helpers\\ColorHelper.cs" +static = true + [[classes]] name = "DeepCopyByExpressionTrees" ns = "FEx.Agnostics.Helpers" @@ -167,18 +371,46 @@ summary = "Superfast deep copier class, which uses Expression trees." file = "Helpers\\DeepCopyByExpressionTrees.cs" static = true +[[extensions]] +name = "DeepCopyByExpressionTree" +returns = "T" +sig = "T DeepCopyByExpressionTree(this T original, Dictionary copiedReferencesDict = null)" +summary = "Creates a deep copy of an object." +file = "Helpers\\DeepCopyByExpressionTrees.cs" + [[classes]] name = "ReferenceEqualityComparer" ns = "FEx.Agnostics.Helpers" base = "EqualityComparer" file = "Helpers\\DeepCopyByExpressionTrees.cs" +[[methods]] +parent = "ReferenceEqualityComparer" +name = "Equals" +sig = "bool Equals(object x, object y)" +returns = "bool" +file = "Helpers\\DeepCopyByExpressionTrees.cs" + +[[methods]] +parent = "ReferenceEqualityComparer" +name = "GetHashCode" +sig = "int GetHashCode(object obj)" +returns = "int" +file = "Helpers\\DeepCopyByExpressionTrees.cs" + [[classes]] name = "DefaultAppVersionProvider" ns = "FEx.Agnostics.Helpers" base = "IAppVersionProvider" file = "Helpers\\DefaultAppVersionProvider.cs" +[[methods]] +parent = "DefaultAppVersionProvider" +name = "GetAppVersion" +sig = "string GetAppVersion()" +returns = "string" +file = "Helpers\\DefaultAppVersionProvider.cs" + [[classes]] name = "FindFilesPatternToRegex" ns = "FEx.Agnostics.Helpers" @@ -187,32 +419,48 @@ static = true [[extensions]] name = "FindFileEmulator" -sig = "string FindFileEmulator(this string pattern, string name)" returns = "string" +sig = "string FindFileEmulator(this string pattern, string name)" file = "Helpers\\FindFilesPatternToRegex.cs" [[extensions]] name = "FindFilesEmulator" -sig = "IEnumerable FindFilesEmulator(this string pattern, params string[] names)" returns = "IEnumerable" +sig = "IEnumerable FindFilesEmulator(this string pattern, params string[] names)" file = "Helpers\\FindFilesPatternToRegex.cs" [[extensions]] name = "FindFileEmulator" -sig = "FileInfo FindFileEmulator(this FileInfo file, params string[] patterns)" returns = "FileInfo" +sig = "FileInfo FindFileEmulator(this FileInfo file, params string[] patterns)" file = "Helpers\\FindFilesPatternToRegex.cs" [[extensions]] name = "FindFilesEmulator" -sig = "IEnumerable FindFilesEmulator(this IEnumerable files, params string[] patterns)" returns = "IEnumerable" +sig = "IEnumerable FindFilesEmulator(this IEnumerable files, params string[] patterns)" +file = "Helpers\\FindFilesPatternToRegex.cs" + +[[methods]] +parent = "FindFilesPatternToRegex" +name = "FindFilesEmulator" +sig = "static IEnumerable FindFilesEmulator(IEnumerable items, Func selector = null, params string[] patterns)" +returns = "IEnumerable" +file = "Helpers\\FindFilesPatternToRegex.cs" +static = true + +[[methods]] +parent = "FindFilesPatternToRegex" +name = "Convert" +sig = "static Regex Convert(string pattern)" +returns = "Regex" file = "Helpers\\FindFilesPatternToRegex.cs" +static = true [[extensions]] name = "PathHasIllegalCharacters" -sig = "bool PathHasIllegalCharacters(this string pattern)" returns = "bool" +sig = "bool PathHasIllegalCharacters(this string pattern)" file = "Helpers\\FindFilesPatternToRegex.cs" [[classes]] @@ -221,6 +469,14 @@ ns = "FEx.Agnostics.Helpers" file = "Helpers\\StringHelpers.cs" static = true +[[methods]] +parent = "StringHelpers" +name = "CountLinesMaybe" +sig = "static long CountLinesMaybe(Stream stream)" +returns = "long" +file = "Helpers\\StringHelpers.cs" +static = true + [[classes]] name = "LoggerState" ns = "FEx.Agnostics.Models" @@ -228,10 +484,152 @@ base = "Dictionary, ILoggerState" summary = "Default implementation of ILoggerState for structured logging scopes." file = "Models\\LoggerState.cs" +[[ctors]] +parent = "LoggerState" +sig = "LoggerState(params (string, object)[] state)" +file = "Models\\LoggerState.cs" + +[[ctors]] +parent = "LoggerState" +sig = "LoggerState(IDictionary dictionary)" +file = "Models\\LoggerState.cs" + +[[methods]] +parent = "LoggerState" +name = "AddOrUpdateLabel" +sig = "void AddOrUpdateLabel(string key, object value)" +returns = "void" +file = "Models\\LoggerState.cs" + +[[methods]] +parent = "LoggerState" +name = "RemoveLabel" +sig = "void RemoveLabel(string key)" +returns = "void" +file = "Models\\LoggerState.cs" + +[[methods]] +parent = "LoggerState" +name = "ToString" +sig = "string ToString()" +returns = "string" +file = "Models\\LoggerState.cs" + [[classes]] name = "AsyncReaderWriterLockSlim" ns = "FEx.Agnostics.Utilities" base = "IDisposable" +summary = "An alternative to which can be used in async methods." +file = "Utilities\\AsyncReaderWriterLockSlim.cs" + +[[ctors]] +parent = "AsyncReaderWriterLockSlim" +sig = "AsyncReaderWriterLockSlim()" +summary = "Initializes a new instance of the class." +file = "Utilities\\AsyncReaderWriterLockSlim.cs" + +[[methods]] +parent = "AsyncReaderWriterLockSlim" +name = "EnterReadLock" +sig = "void EnterReadLock(CancellationToken cancellationToken = default)" +returns = "void" +summary = "Enters the lock in read mode." +file = "Utilities\\AsyncReaderWriterLockSlim.cs" + +[[methods]] +parent = "AsyncReaderWriterLockSlim" +name = "EnterReadLockAsync" +sig = "Task EnterReadLockAsync(CancellationToken cancellationToken = default)" +returns = "Task" +summary = "Asynchronously enters the lock in read mode." +file = "Utilities\\AsyncReaderWriterLockSlim.cs" + +[[methods]] +parent = "AsyncReaderWriterLockSlim" +name = "TryEnterReadLock" +sig = "bool TryEnterReadLock(int millisecondsTimeout = 0, CancellationToken cancellationToken = default)" +returns = "bool" +summary = "Tries to enter the lock in read mode, with an optional integer time-out." +file = "Utilities\\AsyncReaderWriterLockSlim.cs" + +[[methods]] +parent = "AsyncReaderWriterLockSlim" +name = "TryEnterReadLockAsync" +sig = "Task TryEnterReadLockAsync(int millisecondsTimeout = 0, CancellationToken cancellationToken = default)" +returns = "Task" +summary = "Tries to asynchronously enter the lock in read mode, with an optional integer time-out." +file = "Utilities\\AsyncReaderWriterLockSlim.cs" + +[[methods]] +parent = "AsyncReaderWriterLockSlim" +name = "EnterWriteLock" +sig = "void EnterWriteLock(CancellationToken cancellationToken = default)" +returns = "void" +summary = "Enters the lock in write mode." +file = "Utilities\\AsyncReaderWriterLockSlim.cs" + +[[methods]] +parent = "AsyncReaderWriterLockSlim" +name = "EnterWriteLockAsync" +sig = "Task EnterWriteLockAsync(CancellationToken cancellationToken = default)" +returns = "Task" +summary = "Asynchronously enters the lock in write mode." +file = "Utilities\\AsyncReaderWriterLockSlim.cs" + +[[methods]] +parent = "AsyncReaderWriterLockSlim" +name = "TryEnterWriteLock" +sig = "bool TryEnterWriteLock(int millisecondsTimeout = 0, CancellationToken cancellationToken = default)" +returns = "bool" +summary = "Tries to enter the lock in write mode, with an optional integer time-out." +file = "Utilities\\AsyncReaderWriterLockSlim.cs" + +[[methods]] +parent = "AsyncReaderWriterLockSlim" +name = "TryEnterWriteLockAsync" +sig = "Task TryEnterWriteLockAsync(int millisecondsTimeout = 0, CancellationToken cancellationToken = default)" +returns = "Task" +summary = "Tries to asynchronously enter the lock in write mode, with an optional integer time-out." +file = "Utilities\\AsyncReaderWriterLockSlim.cs" + +[[methods]] +parent = "AsyncReaderWriterLockSlim" +name = "DowngradeWriteLockToReadLock" +sig = "void DowngradeWriteLockToReadLock()" +returns = "void" +summary = "Downgrades the lock from write mode to read mode." +file = "Utilities\\AsyncReaderWriterLockSlim.cs" + +[[methods]] +parent = "AsyncReaderWriterLockSlim" +name = "ExitReadLock" +sig = "void ExitReadLock()" +returns = "void" +summary = "Exits read mode." +file = "Utilities\\AsyncReaderWriterLockSlim.cs" + +[[methods]] +parent = "AsyncReaderWriterLockSlim" +name = "ExitWriteLock" +sig = "void ExitWriteLock()" +returns = "void" +summary = "Exits write mode." +file = "Utilities\\AsyncReaderWriterLockSlim.cs" + +[[methods]] +parent = "AsyncReaderWriterLockSlim" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +summary = "Releases all resources used by the ." +file = "Utilities\\AsyncReaderWriterLockSlim.cs" + +[[methods]] +parent = "AsyncReaderWriterLockSlim" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +summary = "Releases the unmanaged resources used by the and optionally releases the managed resources." file = "Utilities\\AsyncReaderWriterLockSlim.cs" [[classes]] @@ -240,39 +638,388 @@ ns = "FEx.Agnostics.Utilities" base = "ICmd" file = "Utilities\\Cmd.cs" -[[classes]] -name = "ExtendedReaderWriterLockSlim" -ns = "FEx.Agnostics.Utilities" -base = "ReaderWriterLockSlim" -file = "Utilities\\ExtendedReaderWriterLockSlim.cs" +[[properties]] +parent = "Cmd" +name = "StartInfo" +sig = "ProcessStartInfo StartInfo { get; set; }" +returns = "ProcessStartInfo" +file = "Utilities\\Cmd.cs" -[[classes]] -name = "ExtendedStringWriter" -ns = "FEx.Agnostics.Utilities" -base = "StringWriter" -file = "Utilities\\ExtendedStringWriter.cs" +[[properties]] +parent = "Cmd" +name = "Proc" +sig = "Process Proc { get; set; }" +returns = "Process" +file = "Utilities\\Cmd.cs" -[[classes]] -name = "FExSingleton" -ns = "FEx.Agnostics.Utilities" -base = "IDisposable" -file = "Utilities\\FExSingleton.cs" +[[properties]] +parent = "Cmd" +name = "Code" +sig = "int? Code { get; set; }" +returns = "int?" +file = "Utilities\\Cmd.cs" -[[classes]] -name = "FExSingleton" -ns = "FEx.Agnostics.Utilities" -base = "FExSingleton where T : class, new()" -file = "Utilities\\FExSingleton.cs" +[[properties]] +parent = "Cmd" +name = "Output" +sig = "StringBuilder Output { get; }" +returns = "StringBuilder" +file = "Utilities\\Cmd.cs" -[[classes]] -name = "FlakDynamicObject" -ns = "FEx.Agnostics.Utilities" -base = "DynamicObject, INotifyPropertyChanged" -file = "Utilities\\FlakDynamicObject.cs" +[[properties]] +parent = "Cmd" +name = "ErrOut" +sig = "StringBuilder ErrOut { get; }" +returns = "StringBuilder" +file = "Utilities\\Cmd.cs" -[[interfaces]] +[[properties]] +parent = "Cmd" +name = "Stopwatch" +sig = "Stopwatch Stopwatch { get; }" +returns = "Stopwatch" +file = "Utilities\\Cmd.cs" + +[[ctors]] +parent = "Cmd" +sig = "Cmd(string procName = \"cmd\", ProcessWindowStyle windowStyle = ProcessWindowStyle.Hidden, Action cfg = null)" +file = "Utilities\\Cmd.cs" + +[[ctors]] +parent = "Cmd" +sig = "Cmd()" +file = "Utilities\\Cmd.cs" + +[[methods]] +parent = "Cmd" +name = "RunAsync" +sig = "Task RunAsync(string args, string verb = null, bool waitForExit = true, Func onStarted = null)" +returns = "Task" +file = "Utilities\\Cmd.cs" + +[[methods]] +parent = "Cmd" +name = "Run" +sig = "void Run(string args, string verb = null, bool waitForExit = true, Action onStarted = null)" +returns = "void" +file = "Utilities\\Cmd.cs" + +[[methods]] +parent = "Cmd" +name = "OnStarted" +sig = "void OnStarted(bool waitForExit, Action onStarted)" +returns = "void" +file = "Utilities\\Cmd.cs" + +[[methods]] +parent = "Cmd" +name = "OnStartedAsync" +sig = "Task OnStartedAsync(bool waitForExit, Func onStarted)" +returns = "Task" +file = "Utilities\\Cmd.cs" + +[[methods]] +parent = "Cmd" +name = "AttachToOutput" +sig = "void AttachToOutput()" +returns = "void" +file = "Utilities\\Cmd.cs" + +[[methods]] +parent = "Cmd" +name = "StartProc" +sig = "void StartProc()" +returns = "void" +file = "Utilities\\Cmd.cs" + +[[methods]] +parent = "Cmd" +name = "SetProc" +sig = "void SetProc(string args, string verb)" +returns = "void" +file = "Utilities\\Cmd.cs" + +[[methods]] +parent = "Cmd" +name = "ErrOutHandler" +sig = "void ErrOutHandler(object sender, DataReceivedEventArgs outLine)" +returns = "void" +file = "Utilities\\Cmd.cs" + +[[methods]] +parent = "Cmd" +name = "OutputHandler" +sig = "void OutputHandler(object sender, DataReceivedEventArgs outLine)" +returns = "void" +file = "Utilities\\Cmd.cs" + +[[methods]] +parent = "Cmd" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Utilities\\Cmd.cs" + +[[methods]] +parent = "Cmd" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +file = "Utilities\\Cmd.cs" + +[[classes]] +name = "ExtendedReaderWriterLockSlim" +ns = "FEx.Agnostics.Utilities" +base = "ReaderWriterLockSlim" +file = "Utilities\\ExtendedReaderWriterLockSlim.cs" + +[[ctors]] +parent = "ExtendedReaderWriterLockSlim" +sig = "ExtendedReaderWriterLockSlim(object owner)" +file = "Utilities\\ExtendedReaderWriterLockSlim.cs" + +[[ctors]] +parent = "ExtendedReaderWriterLockSlim" +sig = "ExtendedReaderWriterLockSlim(object owner, LockRecursionPolicy recursionPolicy)" +file = "Utilities\\ExtendedReaderWriterLockSlim.cs" + +[[methods]] +parent = "ExtendedReaderWriterLockSlim" +name = "Read" +sig = "void Read(Action action)" +returns = "void" +file = "Utilities\\ExtendedReaderWriterLockSlim.cs" + +[[methods]] +parent = "ExtendedReaderWriterLockSlim" +name = "ReadWithResult" +sig = "TResult ReadWithResult(Func action)" +returns = "TResult" +file = "Utilities\\ExtendedReaderWriterLockSlim.cs" + +[[methods]] +parent = "ExtendedReaderWriterLockSlim" +name = "Write" +sig = "void Write(Action action)" +returns = "void" +file = "Utilities\\ExtendedReaderWriterLockSlim.cs" + +[[methods]] +parent = "ExtendedReaderWriterLockSlim" +name = "WriteWithResult" +sig = "TResult WriteWithResult(Func action)" +returns = "TResult" +file = "Utilities\\ExtendedReaderWriterLockSlim.cs" + +[[classes]] +name = "ExtendedStringWriter" +ns = "FEx.Agnostics.Utilities" +base = "StringWriter" +file = "Utilities\\ExtendedStringWriter.cs" + +[[properties]] +parent = "ExtendedStringWriter" +name = "Encoding" +sig = "Encoding Encoding { get; }" +returns = "Encoding" +file = "Utilities\\ExtendedStringWriter.cs" + +[[properties]] +parent = "ExtendedStringWriter" +name = "AutoFlush" +sig = "bool AutoFlush { get; set; }" +returns = "bool" +file = "Utilities\\ExtendedStringWriter.cs" + +[[ctors]] +parent = "ExtendedStringWriter" +sig = "ExtendedStringWriter(StringBuilder builder, bool autoFlush, Encoding desiredEncoding)" +file = "Utilities\\ExtendedStringWriter.cs" + +[[methods]] +parent = "ExtendedStringWriter" +name = "Flush" +sig = "void Flush()" +returns = "void" +file = "Utilities\\ExtendedStringWriter.cs" + +[[methods]] +parent = "ExtendedStringWriter" +name = "Write" +sig = "void Write(char value)" +returns = "void" +file = "Utilities\\ExtendedStringWriter.cs" + +[[methods]] +parent = "ExtendedStringWriter" +name = "Write" +sig = "void Write(string value)" +returns = "void" +file = "Utilities\\ExtendedStringWriter.cs" + +[[methods]] +parent = "ExtendedStringWriter" +name = "Write" +sig = "void Write(char[] buffer, int index, int count)" +returns = "void" +file = "Utilities\\ExtendedStringWriter.cs" + +[[methods]] +parent = "ExtendedStringWriter" +name = "OnFlush" +sig = "void OnFlush()" +returns = "void" +file = "Utilities\\ExtendedStringWriter.cs" + +[[classes]] +name = "FExSingleton" +ns = "FEx.Agnostics.Utilities" +base = "IDisposable" +file = "Utilities\\FExSingleton.cs" + +[[ctors]] +parent = "FExSingleton" +sig = "FExSingleton()" +file = "Utilities\\FExSingleton.cs" + +[[methods]] +parent = "FExSingleton" +name = "ClearAllSingletons" +sig = "static void ClearAllSingletons()" +returns = "void" +file = "Utilities\\FExSingleton.cs" +static = true + +[[methods]] +parent = "FExSingleton" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Utilities\\FExSingleton.cs" + +[[methods]] +parent = "FExSingleton" +name = "Dispose" +sig = "void Dispose(bool isDisposing)" +returns = "void" +file = "Utilities\\FExSingleton.cs" + +[[classes]] +name = "FExSingleton" +ns = "FEx.Agnostics.Utilities" +base = "FExSingleton" +file = "Utilities\\FExSingleton.cs" + +[[properties]] +parent = "FExSingleton" +name = "Instance" +sig = "static T Instance { get; }" +returns = "T" +file = "Utilities\\FExSingleton.cs" +static = true + +[[methods]] +parent = "FExSingleton" +name = "Dispose" +sig = "void Dispose(bool isDisposing)" +returns = "void" +file = "Utilities\\FExSingleton.cs" + +[[classes]] +name = "FlakDynamicObject" +ns = "FEx.Agnostics.Utilities" +base = "DynamicObject, INotifyPropertyChanged" +file = "Utilities\\FlakDynamicObject.cs" + +[[ctors]] +parent = "FlakDynamicObject" +sig = "FlakDynamicObject()" +summary = "Initializes a new instance of the class." +file = "Utilities\\FlakDynamicObject.cs" + +[[ctors]] +parent = "FlakDynamicObject" +sig = "FlakDynamicObject(IDictionary source)" +summary = "Initializes a new instance of the class." +file = "Utilities\\FlakDynamicObject.cs" + +[[methods]] +parent = "FlakDynamicObject" +name = "GetDynamicMemberNames" +sig = "IEnumerable GetDynamicMemberNames()" +returns = "IEnumerable" +summary = "Returns the enumeration of all dynamic member names." +file = "Utilities\\FlakDynamicObject.cs" + +[[methods]] +parent = "FlakDynamicObject" +name = "TryGetMember" +sig = "bool TryGetMember(GetMemberBinder binder, out object result)" +returns = "bool" +summary = "Provides the implementation for operations that get member values. Classes derived from the class can override this method to specify dynamic behavior for operations such as getting a value for a property." +file = "Utilities\\FlakDynamicObject.cs" + +[[methods]] +parent = "FlakDynamicObject" +name = "TrySetMember" +sig = "bool TrySetMember(SetMemberBinder binder, object value)" +returns = "bool" +summary = "Provides the implementation for operations that set member values. Classes derived from the class can override this method to specify dynamic behavior for operations such as setting a value for a property." +file = "Utilities\\FlakDynamicObject.cs" + +[[interfaces]] name = "ICmd" ns = "FEx.Agnostics.Utilities" +base = "IDisposable" +file = "Utilities\\ICmd.cs" + +[[properties]] +parent = "ICmd" +name = "Code" +sig = "int? Code { get; }" +returns = "int?" +file = "Utilities\\ICmd.cs" + +[[properties]] +parent = "ICmd" +name = "ErrOut" +sig = "StringBuilder ErrOut { get; }" +returns = "StringBuilder" +file = "Utilities\\ICmd.cs" + +[[properties]] +parent = "ICmd" +name = "Output" +sig = "StringBuilder Output { get; }" +returns = "StringBuilder" +file = "Utilities\\ICmd.cs" + +[[properties]] +parent = "ICmd" +name = "Proc" +sig = "Process Proc { get; }" +returns = "Process" +file = "Utilities\\ICmd.cs" + +[[properties]] +parent = "ICmd" +name = "StartInfo" +sig = "ProcessStartInfo StartInfo { get; }" +returns = "ProcessStartInfo" +file = "Utilities\\ICmd.cs" + +[[properties]] +parent = "ICmd" +name = "Stopwatch" +sig = "Stopwatch Stopwatch { get; }" +returns = "Stopwatch" +file = "Utilities\\ICmd.cs" + +[[methods]] +parent = "ICmd" +name = "RunAsync" +sig = "Task RunAsync(string args, string verb = null, bool waitForExit = true, Func onStarted = null)" +returns = "Task" file = "Utilities\\ICmd.cs" [[classes]] @@ -280,3 +1027,587 @@ name = "InterlockedBool" ns = "FEx.Agnostics.Utilities" file = "Utilities\\InterlockedBool.cs" +[[properties]] +parent = "InterlockedBool" +name = "Value" +sig = "bool Value { get; set; }" +returns = "bool" +file = "Utilities\\InterlockedBool.cs" + +[[ctors]] +parent = "InterlockedBool" +sig = "InterlockedBool(bool value = false)" +file = "Utilities\\InterlockedBool.cs" + +[[methods]] +parent = "InterlockedBool" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +file = "Utilities\\InterlockedBool.cs" + +[[methods]] +parent = "InterlockedBool" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +file = "Utilities\\InterlockedBool.cs" + +[[classes]] +name = "CollectionDebugView" +ns = "FEx.Agnostics.Collections.Concurrent" +file = "Collections\\Concurrent\\CollectionDebugView.cs" + +[[properties]] +parent = "CollectionDebugView" +name = "Items" +sig = "T[] Items { get; }" +returns = "T[]" +file = "Collections\\Concurrent\\CollectionDebugView.cs" + +[[ctors]] +parent = "CollectionDebugView" +sig = "CollectionDebugView(ICollection collection)" +file = "Collections\\Concurrent\\CollectionDebugView.cs" + +[[classes]] +name = "ConcurrentList" +ns = "FEx.Agnostics.Collections.Concurrent" +base = "BaseConcurrentList, IConcurrentList" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[properties]] +parent = "ConcurrentList" +name = "Count" +sig = "int Count { get; }" +returns = "int" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[properties]] +parent = "ConcurrentList" +name = "IsEmpty" +sig = "bool IsEmpty { get; }" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[properties]] +parent = "ConcurrentList" +name = "Items" +sig = "List Items { get; }" +returns = "List" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[ctors]] +parent = "ConcurrentList" +sig = "ConcurrentList()" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[ctors]] +parent = "ConcurrentList" +sig = "ConcurrentList(IEnumerable collection)" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Add" +sig = "void Add(T item)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Clear" +sig = "void Clear()" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Contains" +sig = "bool Contains(T item)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "CopyTo" +sig = "void CopyTo(T[] array, int arrayIndex)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Remove" +sig = "bool Remove(T item)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "AddRange" +sig = "void AddRange(IEnumerable collection)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "AsReadOnly" +sig = "ReadOnlyCollection AsReadOnly()" +returns = "ReadOnlyCollection" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "AddUnique" +sig = "bool AddUnique(T item)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "AddUniqueRange" +sig = "void AddUniqueRange(IEnumerable range)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "AddUniqueRange" +sig = "void AddUniqueRange(IEnumerable range, Func keySelector, IEqualityComparer comparer)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "RemoveWhere" +sig = "bool RemoveWhere(Func predicate, out List removedItems)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Replace" +sig = "void Replace(int index, T item)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "ReplaceWith" +sig = "void ReplaceWith(IEnumerable collection)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Sort" +sig = "void Sort()" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Sort" +sig = "void Sort(IComparer comparer)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Sort" +sig = "void Sort(int index, int count, IComparer comparer)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Sort" +sig = "void Sort(Comparison comparison)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "SortBy" +sig = "void SortBy(Func selector, ListSortDirection order, IComparer comparer)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Combo" +sig = "void Combo(Action> action, bool shouldTriggerCollectionReset)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Combo" +sig = "bool Combo(Func, bool> shouldTriggerCollectionReset)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Move" +sig = "void Move(int oldIndex, int newIndex)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "GetEnumerator" +sig = "IEnumerator GetEnumerator()" +returns = "IEnumerator" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Add" +sig = "int Add(object value)" +returns = "int" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "IndexOf" +sig = "int IndexOf(T item)" +returns = "int" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Insert" +sig = "void Insert(int index, T item)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "RemoveAt" +sig = "void RemoveAt(int index)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "AddUniqueRange" +sig = "void AddUniqueRange(IEnumerable range, Func keySelector)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "SortBy" +sig = "void SortBy(Func selector)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "SortBy" +sig = "void SortBy(Func selector, ListSortDirection order)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Combo" +sig = "void Combo(Action> action)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "MoveItem" +sig = "void MoveItem(int oldIndex, int newIndex)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "SetItem" +sig = "T SetItem(int index, T item)" +returns = "T" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[methods]] +parent = "ConcurrentList" +name = "WhenCollectionHasBeenReordered" +sig = "void WhenCollectionHasBeenReordered()" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.cs" + +[[classes]] +name = "ConcurrentList" +ns = "FEx.Agnostics.Collections.Concurrent" +file = "Collections\\Concurrent\\ConcurrentList.Impl.cs" + +[[properties]] +parent = "ConcurrentList" +name = "IsSynchronized" +sig = "bool IsSynchronized { get; }" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentList.Impl.cs" + +[[properties]] +parent = "ConcurrentList" +name = "IsFixedSize" +sig = "bool IsFixedSize { get; }" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentList.Impl.cs" + +[[properties]] +parent = "ConcurrentList" +name = "SyncRoot" +sig = "object SyncRoot { get; }" +returns = "object" +file = "Collections\\Concurrent\\ConcurrentList.Impl.cs" + +[[properties]] +parent = "ConcurrentList" +name = "IsReadOnly" +sig = "bool IsReadOnly { get; }" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentList.Impl.cs" + +[[methods]] +parent = "ConcurrentList" +name = "CopyTo" +sig = "void CopyTo(Array array, int index)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.Impl.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Contains" +sig = "bool Contains(object value)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentList.Impl.cs" + +[[methods]] +parent = "ConcurrentList" +name = "IndexOf" +sig = "int IndexOf(object value)" +returns = "int" +file = "Collections\\Concurrent\\ConcurrentList.Impl.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Insert" +sig = "void Insert(int index, object value)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.Impl.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Remove" +sig = "void Remove(object value)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.Impl.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Read" +sig = "void Read(Action action)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.Impl.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Read" +sig = "TResult Read(Func action)" +returns = "TResult" +file = "Collections\\Concurrent\\ConcurrentList.Impl.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Write" +sig = "void Write(Action action)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentList.Impl.cs" + +[[methods]] +parent = "ConcurrentList" +name = "Write" +sig = "TResult Write(Func action)" +returns = "TResult" +file = "Collections\\Concurrent\\ConcurrentList.Impl.cs" + +[[classes]] +name = "ConcurrentSortableList" +ns = "FEx.Agnostics.Collections.Concurrent" +base = "ConcurrentList" +file = "Collections\\Concurrent\\ConcurrentSortableList.cs" + +[[ctors]] +parent = "ConcurrentSortableList" +sig = "ConcurrentSortableList()" +file = "Collections\\Concurrent\\ConcurrentSortableList.cs" + +[[ctors]] +parent = "ConcurrentSortableList" +sig = "ConcurrentSortableList(IEnumerable collection)" +file = "Collections\\Concurrent\\ConcurrentSortableList.cs" + +[[methods]] +parent = "ConcurrentSortableList" +name = "Sort" +sig = "void Sort(ListSortDirection order)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentSortableList.cs" + +[[classes]] +name = "FExMemoryCache" +ns = "FEx.Agnostics.Collections.Concurrent" +base = "IFExMemoryCache, IDictionary, IDictionary" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[ctors]] +parent = "FExMemoryCache" +sig = "FExMemoryCache()" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[methods]] +parent = "FExMemoryCache" +name = "AddOrUpdate" +sig = "TValue AddOrUpdate(TKey key, TValue addValue, Func updateValueFactory)" +returns = "TValue" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[properties]] +parent = "FExMemoryCache" +name = "IsFixedSize" +sig = "bool IsFixedSize { get; }" +returns = "bool" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[properties]] +parent = "FExMemoryCache" +name = "IsSynchronized" +sig = "bool IsSynchronized { get; }" +returns = "bool" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[properties]] +parent = "FExMemoryCache" +name = "SyncRoot" +sig = "object SyncRoot { get; }" +returns = "object" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[properties]] +parent = "FExMemoryCache" +name = "Keys" +sig = "ICollection Keys { get; }" +returns = "ICollection" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[properties]] +parent = "FExMemoryCache" +name = "Values" +sig = "ICollection Values { get; }" +returns = "ICollection" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[methods]] +parent = "FExMemoryCache" +name = "CopyTo" +sig = "void CopyTo(Array array, int index)" +returns = "void" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[methods]] +parent = "FExMemoryCache" +name = "Add" +sig = "void Add(KeyValuePair item)" +returns = "void" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[methods]] +parent = "FExMemoryCache" +name = "Contains" +sig = "bool Contains(KeyValuePair item)" +returns = "bool" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[methods]] +parent = "FExMemoryCache" +name = "CopyTo" +sig = "void CopyTo(KeyValuePair[] array, int arrayIndex)" +returns = "void" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[methods]] +parent = "FExMemoryCache" +name = "Remove" +sig = "bool Remove(KeyValuePair item)" +returns = "bool" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[methods]] +parent = "FExMemoryCache" +name = "Contains" +sig = "bool Contains(object key)" +returns = "bool" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[methods]] +parent = "FExMemoryCache" +name = "Remove" +sig = "void Remove(object key)" +returns = "void" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[methods]] +parent = "FExMemoryCache" +name = "Add" +sig = "void Add(object key, object value)" +returns = "void" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[methods]] +parent = "FExMemoryCache" +name = "Add" +sig = "void Add(TKey key, TValue value)" +returns = "void" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[methods]] +parent = "FExMemoryCache" +name = "ContainsKey" +sig = "bool ContainsKey(TKey key)" +returns = "bool" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[methods]] +parent = "FExMemoryCache" +name = "Remove" +sig = "bool Remove(TKey key)" +returns = "bool" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[methods]] +parent = "FExMemoryCache" +name = "TryGetValue" +sig = "bool TryGetValue(TKey key, out TValue value)" +returns = "bool" +file = "Collections\\Concurrent\\FExMemoryCache.cs" + +[[classes]] +name = "ListDebugView" +ns = "FEx.Agnostics.Collections.Concurrent" +file = "Collections\\Concurrent\\ListDebugView.cs" + +[[properties]] +parent = "ListDebugView" +name = "Items" +sig = "T[] Items { get; }" +returns = "T[]" +file = "Collections\\Concurrent\\ListDebugView.cs" + +[[ctors]] +parent = "ListDebugView" +sig = "ListDebugView(IList collection)" +file = "Collections\\Concurrent\\ListDebugView.cs" + diff --git a/.api-surface/FEx/ApiSurfaceGen.toml b/.api-surface/FEx/ApiSurfaceGen.toml new file mode 100644 index 00000000..9784632a --- /dev/null +++ b/.api-surface/FEx/ApiSurfaceGen.toml @@ -0,0 +1,10 @@ +[project] +name = "FEx.ApiSurfaceGen" +path = "tools\\FEx.ApiSurfaceGen" + +[[classes]] +name = "Program" +ns = "FEx.ApiSurfaceGen" +file = "Program.cs" +static = true + diff --git a/.api-surface/FEx/AppSettings.toml b/.api-surface/FEx/AppSettings.toml index f6e26a59..ba48a845 100644 --- a/.api-surface/FEx/AppSettings.toml +++ b/.api-surface/FEx/AppSettings.toml @@ -8,21 +8,71 @@ ns = "FEx.AppSettings" base = "IConfigurationService" file = "ConfigurationService.cs" +[[properties]] +parent = "ConfigurationService" +name = "Configuration" +sig = "IConfigurationRoot Configuration { get; }" +returns = "IConfigurationRoot" +file = "ConfigurationService.cs" + +[[properties]] +parent = "ConfigurationService" +name = "AppSettings" +sig = "Dictionary AppSettings { get; }" +returns = "Dictionary" +file = "ConfigurationService.cs" + +[[methods]] +parent = "ConfigurationService" +name = "Build" +sig = "void Build(IEnumerable sources)" +returns = "void" +file = "ConfigurationService.cs" + +[[methods]] +parent = "ConfigurationService" +name = "GetSetting" +sig = "T GetSetting(string key, Func func)" +returns = "T" +file = "ConfigurationService.cs" + +[[methods]] +parent = "ConfigurationService" +name = "GetBoolSetting" +sig = "bool? GetBoolSetting(string key, bool? defaultValue)" +returns = "bool?" +file = "ConfigurationService.cs" + [[classes]] name = "FExAppSettings" ns = "FEx.AppSettings" base = "FExInitializable" file = "FExAppSettings.cs" +[[methods]] +parent = "FExAppSettings" +name = "OnInitialize" +sig = "void OnInitialize()" +returns = "void" +file = "FExAppSettings.cs" + [[classes]] name = "FExAppSettingsModule" ns = "FEx.AppSettings" base = "InitializeModule" file = "FExAppSettingsModule.cs" +[[methods]] +parent = "FExAppSettingsModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExAppSettingsModule container, IServiceCollection services)" +returns = "void" +file = "FExAppSettingsModule.cs" + [[interfaces]] name = "IFExAppSettingsModule" ns = "FEx.AppSettings" +base = "IContainer, IContainer" file = "IFExAppSettingsModule.cs" [[enums]] @@ -36,21 +86,91 @@ ns = "FEx.AppSettings.Abstractions" base = "SecureNotifyPropertyChanged, IBaseUserSettings" file = "Abstractions\\BaseUserSettings.cs" +[[properties]] +parent = "BaseUserSettings" +name = "PersistencePath" +sig = "string PersistencePath { get; }" +returns = "string" +file = "Abstractions\\BaseUserSettings.cs" + +[[properties]] +parent = "BaseUserSettings" +name = "IsAsync" +sig = "bool IsAsync { get; }" +returns = "bool" +file = "Abstractions\\BaseUserSettings.cs" + +[[methods]] +parent = "BaseUserSettings" +name = "Initialize" +sig = "void Initialize(string persistencePath, (bool hasBeenReadFromFile, bool isAsync) tuple)" +returns = "void" +file = "Abstractions\\BaseUserSettings.cs" + +[[methods]] +parent = "BaseUserSettings" +name = "SetProperty" +sig = "bool SetProperty(ref TRet backingField, TRet newValue, Action onPropertyChanged = null, [CallerMemberName] string propertyName = null)" +returns = "bool" +file = "Abstractions\\BaseUserSettings.cs" + +[[methods]] +parent = "BaseUserSettings" +name = "SaveSettings" +sig = "void SaveSettings()" +returns = "void" +file = "Abstractions\\BaseUserSettings.cs" + +[[methods]] +parent = "BaseUserSettings" +name = "SaveSettingsAsync" +sig = "Task SaveSettingsAsync()" +returns = "Task" +file = "Abstractions\\BaseUserSettings.cs" + +[[methods]] +parent = "BaseUserSettings" +name = "SerializedInstance" +sig = "string SerializedInstance()" +returns = "string" +file = "Abstractions\\BaseUserSettings.cs" + +[[methods]] +parent = "BaseUserSettings" +name = "OnCreated" +sig = "void OnCreated()" +returns = "void" +file = "Abstractions\\BaseUserSettings.cs" + [[classes]] name = "BaseUserSettings" ns = "FEx.AppSettings.Abstractions" -base = "BaseUserSettings where T : BaseUserSettings, new()" +base = "BaseUserSettings" file = "Abstractions\\BaseUserSettings.cs" -[[interfaces]] -name = "IBaseUserSettings" -ns = "FEx.AppSettings.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IBaseUserSettings.cs" +[[methods]] +parent = "BaseUserSettings" +name = "GetSettings" +sig = "static T GetSettings(string persistencePath, bool isAsync)" +returns = "T" +file = "Abstractions\\BaseUserSettings.cs" +static = true -[[interfaces]] -name = "IConfigurationService" -ns = "FEx.AppSettings.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IConfigurationService.cs" +[[methods]] +parent = "BaseUserSettings" +name = "GetSettings" +sig = "static T GetSettings()" +returns = "T" +file = "Abstractions\\BaseUserSettings.cs" +static = true + +[[methods]] +parent = "BaseUserSettings" +name = "GetSettings" +sig = "static T GetSettings(string persistencePath)" +returns = "T" +file = "Abstractions\\BaseUserSettings.cs" +static = true [[classes]] name = "LegacyConfigurationProvider" @@ -58,12 +178,34 @@ ns = "FEx.AppSettings.ConfigurationEx" base = "ConfigurationProvider, IConfigurationSource" file = "ConfigurationEx\\LegacyConfigurationProvider.cs" +[[methods]] +parent = "LegacyConfigurationProvider" +name = "Build" +sig = "IConfigurationProvider Build(IConfigurationBuilder builder)" +returns = "IConfigurationProvider" +file = "ConfigurationEx\\LegacyConfigurationProvider.cs" + +[[methods]] +parent = "LegacyConfigurationProvider" +name = "Load" +sig = "void Load()" +returns = "void" +file = "ConfigurationEx\\LegacyConfigurationProvider.cs" + [[classes]] name = "ConfigurationManagerExtensions" ns = "FEx.AppSettings.Extensions" file = "Extensions\\ConfigurationManagerExtensions.cs" static = true +[[methods]] +parent = "ConfigurationManagerExtensions" +name = "MergeAppSettings" +sig = "static void MergeAppSettings()" +returns = "void" +file = "Extensions\\ConfigurationManagerExtensions.cs" +static = true + [[classes]] name = "ConfigurationServiceExtensions" ns = "FEx.AppSettings.Extensions" @@ -72,8 +214,14 @@ static = true [[extensions]] name = "Build" -sig = "void Build(this IConfigurationService service)" returns = "void" +sig = "void Build(this IConfigurationService service)" +file = "Extensions\\ConfigurationServiceExtensions.cs" + +[[extensions]] +name = "GetBoolSetting" +returns = "bool?" +sig = "bool? GetBoolSetting(this IConfigurationService service, string key)" file = "Extensions\\ConfigurationServiceExtensions.cs" [[classes]] @@ -82,18 +230,121 @@ ns = "FEx.AppSettings.Extensions" file = "Extensions\\FExConfigurationExtensions.cs" static = true +[[extensions]] +name = "VerifyAppSettings" +returns = "T" +sig = "T VerifyAppSettings(this T appSettings, params Expression>[] keys)" +file = "Extensions\\FExConfigurationExtensions.cs" + +[[methods]] +parent = "FExConfigurationExtensions" +name = "GetBindedConfiguration" +sig = "static TConf GetBindedConfiguration(string sectionKey, string basePath, string settingsFilePath)" +returns = "TConf" +file = "Extensions\\FExConfigurationExtensions.cs" +static = true + +[[methods]] +parent = "FExConfigurationExtensions" +name = "GetBindedConfiguration" +sig = "static TConf GetBindedConfiguration()" +returns = "TConf" +file = "Extensions\\FExConfigurationExtensions.cs" +static = true + +[[methods]] +parent = "FExConfigurationExtensions" +name = "GetBindedConfiguration" +sig = "static TConf GetBindedConfiguration(string sectionKey)" +returns = "TConf" +file = "Extensions\\FExConfigurationExtensions.cs" +static = true + +[[methods]] +parent = "FExConfigurationExtensions" +name = "GetBindedConfiguration" +sig = "static TConf GetBindedConfiguration(string sectionKey, string basePath)" +returns = "TConf" +file = "Extensions\\FExConfigurationExtensions.cs" +static = true + [[extensions]] name = "BindJsonNet" -sig = "void BindJsonNet(this IConfigurationSection config, object instance, Func jsonFunc)" returns = "void" +sig = "void BindJsonNet(this IConfigurationSection config, object instance, Func jsonFunc)" file = "Extensions\\FExConfigurationExtensions.cs" [[extensions]] name = "BindJsonNet" -sig = "void BindJsonNet(this IConfigurationSection config, object instance)" returns = "void" +sig = "void BindJsonNet(this IConfigurationSection config, object instance)" +file = "Extensions\\FExConfigurationExtensions.cs" + +[[extensions]] +name = "BindJsonNet" +returns = "T" +sig = "T BindJsonNet(this IConfigurationSection config, Func jsonFunc)" file = "Extensions\\FExConfigurationExtensions.cs" +[[extensions]] +name = "BindJsonNet" +returns = "T" +sig = "T BindJsonNet(this IConfigurationSection config)" +file = "Extensions\\FExConfigurationExtensions.cs" + +[[interfaces]] +name = "IBaseUserSettings" +ns = "FEx.AppSettings.Abstractions.Interfaces" +base = "INotifyPropertyChanged" +file = "Abstractions\\Interfaces\\IBaseUserSettings.cs" + +[[properties]] +parent = "IBaseUserSettings" +name = "PersistencePath" +sig = "string PersistencePath { get; }" +returns = "string" +file = "Abstractions\\Interfaces\\IBaseUserSettings.cs" + +[[interfaces]] +name = "IConfigurationService" +ns = "FEx.AppSettings.Abstractions.Interfaces" +file = "Abstractions\\Interfaces\\IConfigurationService.cs" + +[[properties]] +parent = "IConfigurationService" +name = "AppSettings" +sig = "Dictionary AppSettings { get; }" +returns = "Dictionary" +file = "Abstractions\\Interfaces\\IConfigurationService.cs" + +[[properties]] +parent = "IConfigurationService" +name = "Configuration" +sig = "IConfigurationRoot Configuration { get; }" +returns = "IConfigurationRoot" +file = "Abstractions\\Interfaces\\IConfigurationService.cs" + +[[methods]] +parent = "IConfigurationService" +name = "Build" +sig = "void Build(IEnumerable sources)" +returns = "void" +file = "Abstractions\\Interfaces\\IConfigurationService.cs" + +[[methods]] +parent = "IConfigurationService" +name = "GetBoolSetting" +sig = "bool? GetBoolSetting(string key, bool? defaultValue)" +returns = "bool?" +file = "Abstractions\\Interfaces\\IConfigurationService.cs" + +[[methods]] +parent = "IConfigurationService" +name = "GetSetting" +sig = "T GetSetting(string key, Func func)" +returns = "T" +file = "Abstractions\\Interfaces\\IConfigurationService.cs" + [[classes]] name = "SettingsExtensions" ns = "FEx.AppSettings.Extensions.Settings" @@ -102,8 +353,8 @@ static = true [[extensions]] name = "SaveAndReloadSettings" -sig = "void SaveAndReloadSettings(this ApplicationSettingsBase settings)" returns = "void" +sig = "void SaveAndReloadSettings(this ApplicationSettingsBase settings)" summary = "Saves the and reload settings." file = "Extensions\\Settings\\SettingsExtensions.cs" diff --git a/.api-surface/FEx/Asyncx.toml b/.api-surface/FEx/Asyncx.toml index 64cbbd2e..e644484e 100644 --- a/.api-surface/FEx/Asyncx.toml +++ b/.api-surface/FEx/Asyncx.toml @@ -8,6 +8,18 @@ ns = "FEx.Asyncx" base = "FExInitializable" file = "FExAsyncx.cs" +[[ctors]] +parent = "FExAsyncx" +sig = "FExAsyncx(IMainThreadContextProvider mainThreadContextProvider)" +file = "FExAsyncx.cs" + +[[methods]] +parent = "FExAsyncx" +name = "OnInitialize" +sig = "void OnInitialize()" +returns = "void" +file = "FExAsyncx.cs" + [[classes]] name = "AsyncAutoInitializable" ns = "FEx.Asyncx.Abstractions" @@ -20,12 +32,185 @@ ns = "FEx.Asyncx.Abstractions" base = "NotifyPropertyChanged, IAsyncInitializable" file = "Abstractions\\AsyncInitializable.cs" +[[properties]] +parent = "AsyncInitializable" +name = "IsInitialized" +sig = "bool IsInitialized { get; }" +returns = "bool" +file = "Abstractions\\AsyncInitializable.cs" + +[[properties]] +parent = "AsyncInitializable" +name = "HasFinishedInitialization" +sig = "bool HasFinishedInitialization { get; }" +returns = "bool" +file = "Abstractions\\AsyncInitializable.cs" + +[[properties]] +parent = "AsyncInitializable" +name = "IsInitializing" +sig = "bool IsInitializing { get; }" +returns = "bool" +file = "Abstractions\\AsyncInitializable.cs" + +[[properties]] +parent = "AsyncInitializable" +name = "TypeName" +sig = "string TypeName { get; set; }" +returns = "string" +file = "Abstractions\\AsyncInitializable.cs" + +[[properties]] +parent = "AsyncInitializable" +name = "TypeFullName" +sig = "string TypeFullName { get; set; }" +returns = "string" +file = "Abstractions\\AsyncInitializable.cs" + +[[properties]] +parent = "AsyncInitializable" +name = "SkipDependenciesInitialization" +sig = "bool SkipDependenciesInitialization { get; set; }" +returns = "bool" +summary = "If true doesn't wait for dependencies initialization" +file = "Abstractions\\AsyncInitializable.cs" + +[[ctors]] +parent = "AsyncInitializable" +sig = "AsyncInitializable(params IAsyncInitializable[] dependencies)" +file = "Abstractions\\AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializable" +name = "InitializeAsync" +sig = "Task InitializeAsync()" +returns = "Task" +file = "Abstractions\\AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializable" +name = "Reset" +sig = "void Reset()" +returns = "void" +file = "Abstractions\\AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializable" +name = "BeginInitialization" +sig = "void BeginInitialization(bool waitSynchronouslyForInitialization)" +returns = "void" +file = "Abstractions\\AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializable" +name = "BeginInitialization" +sig = "void BeginInitialization()" +returns = "void" +file = "Abstractions\\AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializable" +name = "SafeInitializeAsync" +sig = "static Task> SafeInitializeAsync(IAsyncInitializable dependency)" +returns = "Task>" +file = "Abstractions\\AsyncInitializable.cs" +static = true + +[[methods]] +parent = "AsyncInitializable" +name = "OnInitializeAsync" +sig = "Task OnInitializeAsync()" +returns = "Task" +file = "Abstractions\\AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializable" +name = "InitializeDependenciesAsync" +sig = "Task InitializeDependenciesAsync()" +returns = "Task" +file = "Abstractions\\AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializable" +name = "InitializeCoreAsync" +sig = "Task InitializeCoreAsync()" +returns = "Task" +file = "Abstractions\\AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializable" +name = "ThrowIfNotInitialized" +sig = "void ThrowIfNotInitialized()" +returns = "void" +file = "Abstractions\\AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializable" +name = "AddDependencies" +sig = "void AddDependencies(params IAsyncInitializable[] dependencies)" +returns = "void" +file = "Abstractions\\AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializable" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Abstractions\\AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializable" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +file = "Abstractions\\AsyncInitializable.cs" + [[classes]] name = "AsyncBuffer" ns = "FEx.Asyncx.Collections" base = "IDisposable" file = "Collections\\AsyncBuffer.cs" +[[ctors]] +parent = "AsyncBuffer" +sig = "AsyncBuffer()" +file = "Collections\\AsyncBuffer.cs" + +[[methods]] +parent = "AsyncBuffer" +name = "RetrieveFromBufferAsync" +sig = "Task> RetrieveFromBufferAsync(CancellationToken cancellationToken)" +returns = "Task>" +file = "Collections\\AsyncBuffer.cs" + +[[methods]] +parent = "AsyncBuffer" +name = "AddToBufferAsync" +sig = "Task AddToBufferAsync(IEnumerable changes, CancellationToken cancellationToken)" +returns = "Task" +file = "Collections\\AsyncBuffer.cs" + +[[methods]] +parent = "AsyncBuffer" +name = "RetrieveFromBuffer" +sig = "IList RetrieveFromBuffer(IList buffer)" +returns = "IList" +file = "Collections\\AsyncBuffer.cs" + +[[methods]] +parent = "AsyncBuffer" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Collections\\AsyncBuffer.cs" + +[[methods]] +parent = "AsyncBuffer" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +file = "Collections\\AsyncBuffer.cs" + [[classes]] name = "JoinableTaskExtensions" ns = "FEx.Asyncx.Extensions" @@ -34,28 +219,350 @@ static = true [[extensions]] name = "WaitWithoutThreadLock" -sig = "void WaitWithoutThreadLock(this Func taskFactory, - AsyncOptions options = AsyncOptions.ImmediateStart)" returns = "void" +sig = "void WaitWithoutThreadLock(this Func taskFactory, AsyncOptions options = AsyncOptions.ImmediateStart)" file = "Extensions\\JoinableTaskExtensions.cs" +[[extensions]] +name = "WaitWithoutThreadLock" +returns = "T" +sig = "T WaitWithoutThreadLock(this Func> taskFactory, AsyncOptions options = AsyncOptions.ImmediateStart)" +file = "Extensions\\JoinableTaskExtensions.cs" + +[[extensions]] +name = "WaitWithoutThreadLock" +returns = "T[]" +sig = "T[] WaitWithoutThreadLock(this Func> taskFactory, AsyncOptions options = AsyncOptions.ImmediateStart)" +file = "Extensions\\JoinableTaskExtensions.cs" + +[[extensions]] +name = "WaitWithoutThreadLockAsync" +returns = "Task" +sig = "Task WaitWithoutThreadLockAsync(this Func taskFactory, AsyncOptions options = AsyncOptions.ImmediateStart)" +file = "Extensions\\JoinableTaskExtensions.cs" + +[[extensions]] +name = "WaitWithoutThreadLockAsync" +returns = "Task" +sig = "Task WaitWithoutThreadLockAsync(this Func> taskFactory, AsyncOptions options = AsyncOptions.ImmediateStart)" +file = "Extensions\\JoinableTaskExtensions.cs" + +[[extensions]] +name = "WaitWithoutThreadLockAsync" +returns = "Task" +sig = "Task WaitWithoutThreadLockAsync(this Func> taskFactory, AsyncOptions options = AsyncOptions.ImmediateStart)" +file = "Extensions\\JoinableTaskExtensions.cs" + +[[extensions]] +name = "WhenAllJoinedAsync" +returns = "Task" +sig = "Task WhenAllJoinedAsync(this IEnumerable> tasks)" +file = "Extensions\\JoinableTaskExtensions.cs" + +[[extensions]] +name = "WhenAllJoinedAsync" +returns = "Task" +sig = "Task WhenAllJoinedAsync(this IEnumerable tasks)" +file = "Extensions\\JoinableTaskExtensions.cs" + +[[methods]] +parent = "JoinableTaskExtensions" +name = "FireOrWait" +sig = "static void FireOrWait(Func func, bool wait)" +returns = "void" +file = "Extensions\\JoinableTaskExtensions.cs" +static = true + +[[methods]] +parent = "JoinableTaskExtensions" +name = "FireOrWait" +sig = "static T FireOrWait(Func> func, bool wait)" +returns = "T" +file = "Extensions\\JoinableTaskExtensions.cs" +static = true + +[[methods]] +parent = "JoinableTaskExtensions" +name = "SwitchToThreadPoolAsync" +sig = "static Task SwitchToThreadPoolAsync(Func function)" +returns = "Task" +file = "Extensions\\JoinableTaskExtensions.cs" +static = true + +[[methods]] +parent = "JoinableTaskExtensions" +name = "SwitchToThreadPoolAsync" +sig = "static Task SwitchToThreadPoolAsync(Func> function)" +returns = "Task" +file = "Extensions\\JoinableTaskExtensions.cs" +static = true + [[classes]] name = "AsyncProcessingQueue" ns = "FEx.Asyncx.Helpers" base = "IDisposable" file = "Helpers\\AsyncProcessingQueue.cs" +[[properties]] +parent = "AsyncProcessingQueue" +name = "ConcurrencyLimit" +sig = "uint ConcurrencyLimit { get; set; }" +returns = "uint" +summary = "Dynamically updates the maximum allowed concurrency. When increasing, waiting tasks are released immediately in FIFO order." +file = "Helpers\\AsyncProcessingQueue.cs" + +[[properties]] +parent = "AsyncProcessingQueue" +name = "RunningCount" +sig = "int RunningCount { get; }" +returns = "int" +file = "Helpers\\AsyncProcessingQueue.cs" + +[[properties]] +parent = "AsyncProcessingQueue" +name = "QueuedCount" +sig = "int QueuedCount { get; }" +returns = "int" +file = "Helpers\\AsyncProcessingQueue.cs" + +[[ctors]] +parent = "AsyncProcessingQueue" +sig = "AsyncProcessingQueue()" +file = "Helpers\\AsyncProcessingQueue.cs" + +[[ctors]] +parent = "AsyncProcessingQueue" +sig = "AsyncProcessingQueue(uint limit)" +file = "Helpers\\AsyncProcessingQueue.cs" + +[[methods]] +parent = "AsyncProcessingQueue" +name = "EnqueueAsync" +sig = "Task EnqueueAsync(Func taskFunc)" +returns = "Task" +summary = "Schedules a task in FIFO order." +file = "Helpers\\AsyncProcessingQueue.cs" + +[[methods]] +parent = "AsyncProcessingQueue" +name = "EnqueueAsync" +sig = "Task EnqueueAsync(Func taskFunc, CancellationToken cancellationToken)" +returns = "Task" +file = "Helpers\\AsyncProcessingQueue.cs" + +[[methods]] +parent = "AsyncProcessingQueue" +name = "EnqueueAsync" +sig = "Task EnqueueAsync(Func> taskFunc)" +returns = "Task" +summary = "Schedules a task with result in FIFO order." +file = "Helpers\\AsyncProcessingQueue.cs" + +[[methods]] +parent = "AsyncProcessingQueue" +name = "EnqueueAsync" +sig = "Task EnqueueAsync(Func> taskFunc, CancellationToken cancellationToken)" +returns = "Task" +file = "Helpers\\AsyncProcessingQueue.cs" + +[[methods]] +parent = "AsyncProcessingQueue" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Helpers\\AsyncProcessingQueue.cs" + [[classes]] name = "JoinableAsyncHelper" ns = "FEx.Asyncx.Helpers" file = "Helpers\\JoinableAsyncHelper.cs" static = true +[[methods]] +parent = "JoinableAsyncHelper" +name = "SetMainJoinableTaskFactory" +sig = "static void SetMainJoinableTaskFactory(Thread mainThread)" +returns = "void" +file = "Helpers\\JoinableAsyncHelper.cs" +static = true + +[[methods]] +parent = "JoinableAsyncHelper" +name = "DelayWithoutDeadlockAsync" +sig = "static Task DelayWithoutDeadlockAsync(int millisecondsDelay)" +returns = "Task" +file = "Helpers\\JoinableAsyncHelper.cs" +static = true + +[[methods]] +parent = "JoinableAsyncHelper" +name = "DelayWithoutDeadlockAsync" +sig = "static Task DelayWithoutDeadlockAsync(int millisecondsDelay, CancellationToken cancellationToken)" +returns = "Task" +file = "Helpers\\JoinableAsyncHelper.cs" +static = true + +[[methods]] +parent = "JoinableAsyncHelper" +name = "DelayWithoutDeadlock" +sig = "static void DelayWithoutDeadlock(int millisecondsDelay)" +returns = "void" +file = "Helpers\\JoinableAsyncHelper.cs" +static = true + +[[methods]] +parent = "JoinableAsyncHelper" +name = "AwaitWithoutDeadlockAsync" +sig = "static Task AwaitWithoutDeadlockAsync(Func func)" +returns = "Task" +file = "Helpers\\JoinableAsyncHelper.cs" +static = true + +[[methods]] +parent = "JoinableAsyncHelper" +name = "AwaitWithoutDeadlockAsync" +sig = "static Task AwaitWithoutDeadlockAsync(Func func, bool onMainThread)" +returns = "Task" +file = "Helpers\\JoinableAsyncHelper.cs" +static = true + +[[methods]] +parent = "JoinableAsyncHelper" +name = "AwaitWithoutDeadlock" +sig = "static void AwaitWithoutDeadlock(Func func)" +returns = "void" +file = "Helpers\\JoinableAsyncHelper.cs" +static = true + +[[methods]] +parent = "JoinableAsyncHelper" +name = "AwaitWithoutDeadlock" +sig = "static void AwaitWithoutDeadlock(Func func, bool onMainThread)" +returns = "void" +file = "Helpers\\JoinableAsyncHelper.cs" +static = true + +[[methods]] +parent = "JoinableAsyncHelper" +name = "AwaitWithoutDeadlockAsync" +sig = "static Task AwaitWithoutDeadlockAsync(Func> func)" +returns = "Task" +file = "Helpers\\JoinableAsyncHelper.cs" +static = true + +[[methods]] +parent = "JoinableAsyncHelper" +name = "AwaitWithoutDeadlockAsync" +sig = "static Task AwaitWithoutDeadlockAsync(Func> func, bool onMainThread)" +returns = "Task" +file = "Helpers\\JoinableAsyncHelper.cs" +static = true + +[[methods]] +parent = "JoinableAsyncHelper" +name = "AwaitWithoutDeadlock" +sig = "static T AwaitWithoutDeadlock(Func> func)" +returns = "T" +file = "Helpers\\JoinableAsyncHelper.cs" +static = true + +[[methods]] +parent = "JoinableAsyncHelper" +name = "AwaitWithoutDeadlock" +sig = "static T AwaitWithoutDeadlock(Func> func, bool onMainThread)" +returns = "T" +file = "Helpers\\JoinableAsyncHelper.cs" +static = true + +[[methods]] +parent = "JoinableAsyncHelper" +name = "GetFactory" +sig = "static JoinableTaskFactoryHandler GetFactory()" +returns = "JoinableTaskFactoryHandler" +file = "Helpers\\JoinableAsyncHelper.cs" +static = true + +[[methods]] +parent = "JoinableAsyncHelper" +name = "GetFactory" +sig = "static JoinableTaskFactoryHandler GetFactory(Thread thread, bool replace)" +returns = "JoinableTaskFactoryHandler" +file = "Helpers\\JoinableAsyncHelper.cs" +static = true + [[classes]] name = "JoinableTaskFactoryHandler" ns = "FEx.Asyncx.Helpers" file = "Helpers\\JoinableTaskFactoryHandler.cs" +[[properties]] +parent = "JoinableTaskFactoryHandler" +name = "ThreadId" +sig = "int ThreadId { get; }" +returns = "int" +file = "Helpers\\JoinableTaskFactoryHandler.cs" + +[[ctors]] +parent = "JoinableTaskFactoryHandler" +sig = "JoinableTaskFactoryHandler(int threadId, JoinableTaskFactory jtf)" +file = "Helpers\\JoinableTaskFactoryHandler.cs" + +[[methods]] +parent = "JoinableTaskFactoryHandler" +name = "Run" +sig = "void Run(Func asyncMethod)" +returns = "void" +file = "Helpers\\JoinableTaskFactoryHandler.cs" + +[[methods]] +parent = "JoinableTaskFactoryHandler" +name = "Run" +sig = "void Run(Func asyncMethod, JoinableTaskCreationOptions creationOptions)" +returns = "void" +file = "Helpers\\JoinableTaskFactoryHandler.cs" + +[[methods]] +parent = "JoinableTaskFactoryHandler" +name = "Run" +sig = "T Run(Func> asyncMethod)" +returns = "T" +file = "Helpers\\JoinableTaskFactoryHandler.cs" + +[[methods]] +parent = "JoinableTaskFactoryHandler" +name = "Run" +sig = "T Run(Func> asyncMethod, JoinableTaskCreationOptions creationOptions)" +returns = "T" +file = "Helpers\\JoinableTaskFactoryHandler.cs" + +[[methods]] +parent = "JoinableTaskFactoryHandler" +name = "RunAsync" +sig = "Task RunAsync(Func asyncMethod)" +returns = "Task" +file = "Helpers\\JoinableTaskFactoryHandler.cs" + +[[methods]] +parent = "JoinableTaskFactoryHandler" +name = "RunAsync" +sig = "Task RunAsync(Func asyncMethod, string parentToken, JoinableTaskCreationOptions creationOptions)" +returns = "Task" +file = "Helpers\\JoinableTaskFactoryHandler.cs" + +[[methods]] +parent = "JoinableTaskFactoryHandler" +name = "RunAsync" +sig = "Task> RunAsync(Func> asyncMethod)" +returns = "Task>" +file = "Helpers\\JoinableTaskFactoryHandler.cs" + +[[methods]] +parent = "JoinableTaskFactoryHandler" +name = "RunAsync" +sig = "Task> RunAsync(Func> asyncMethod, string parentToken, JoinableTaskCreationOptions creationOptions)" +returns = "Task>" +file = "Helpers\\JoinableTaskFactoryHandler.cs" + [[interfaces]] name = "IAsyncWorkerConfig" ns = "FEx.Asyncx.Interfaces" @@ -64,23 +571,181 @@ file = "Interfaces\\IAsyncWorkerConfig.cs" [[classes]] name = "AsyncWorker" ns = "FEx.Asyncx.Services" -base = "AsyncInitializable where T : class" +base = "AsyncInitializable" +file = "Services\\AsyncWorker.cs" + +[[properties]] +parent = "AsyncWorker" +name = "Id" +sig = "int Id { get; }" +returns = "int" +file = "Services\\AsyncWorker.cs" + +[[properties]] +parent = "AsyncWorker" +name = "CurrentTask" +sig = "Task CurrentTask { get; }" +returns = "Task" +file = "Services\\AsyncWorker.cs" + +[[properties]] +parent = "AsyncWorker" +name = "IdleTask" +sig = "Task IdleTask { get; }" +returns = "Task" +file = "Services\\AsyncWorker.cs" + +[[properties]] +parent = "AsyncWorker" +name = "IsBusy" +sig = "bool IsBusy { get; }" +returns = "bool" +file = "Services\\AsyncWorker.cs" + +[[ctors]] +parent = "AsyncWorker" +sig = "AsyncWorker(int id)" +file = "Services\\AsyncWorker.cs" + +[[methods]] +parent = "AsyncWorker" +name = "ExecuteTaskAsync" +sig = "Task ExecuteTaskAsync(Func> func)" +returns = "Task" +file = "Services\\AsyncWorker.cs" + +[[methods]] +parent = "AsyncWorker" +name = "EndCurrentTask" +sig = "void EndCurrentTask()" +returns = "void" +file = "Services\\AsyncWorker.cs" + +[[methods]] +parent = "AsyncWorker" +name = "OnInitializeAsync" +sig = "Task OnInitializeAsync()" +returns = "Task" +file = "Services\\AsyncWorker.cs" + +[[methods]] +parent = "AsyncWorker" +name = "ExecuteAsync" +sig = "Task ExecuteAsync(Func> func)" +returns = "Task" file = "Services\\AsyncWorker.cs" [[classes]] name = "AsyncWorkersPool" ns = "FEx.Asyncx.Services" -base = "AsyncInitializable - where TWorker : AsyncWorker" +base = "AsyncInitializable" +file = "Services\\AsyncWorkersPool.cs" + +[[properties]] +parent = "AsyncWorkersPool" +name = "IdleWorker" +sig = "TWorker IdleWorker { get; set; }" +returns = "TWorker" +file = "Services\\AsyncWorkersPool.cs" + +[[properties]] +parent = "AsyncWorkersPool" +name = "ProcessingQueue" +sig = "AsyncProcessingQueue ProcessingQueue { get; }" +returns = "AsyncProcessingQueue" +file = "Services\\AsyncWorkersPool.cs" + +[[properties]] +parent = "AsyncWorkersPool" +name = "Workers" +sig = "ConcurrentList Workers { get; }" +returns = "ConcurrentList" +file = "Services\\AsyncWorkersPool.cs" + +[[ctors]] +parent = "AsyncWorkersPool" +sig = "AsyncWorkersPool(uint poolSize)" +file = "Services\\AsyncWorkersPool.cs" + +[[methods]] +parent = "AsyncWorkersPool" +name = "ExecuteOnPoolAsync" +sig = "Task ExecuteOnPoolAsync(Func> func)" +returns = "Task" +file = "Services\\AsyncWorkersPool.cs" + +[[methods]] +parent = "AsyncWorkersPool" +name = "ExecuteOnPoolAsync" +sig = "Task ExecuteOnPoolAsync(Func> func, Func getId)" +returns = "Task" +file = "Services\\AsyncWorkersPool.cs" + +[[methods]] +parent = "AsyncWorkersPool" +name = "WaitForAllClientsAsync" +sig = "Task WaitForAllClientsAsync()" +returns = "Task" +file = "Services\\AsyncWorkersPool.cs" + +[[methods]] +parent = "AsyncWorkersPool" +name = "GetNewWorker" +sig = "TWorker GetNewWorker(int id)" +returns = "TWorker" +file = "Services\\AsyncWorkersPool.cs" + +[[methods]] +parent = "AsyncWorkersPool" +name = "OnInitializeAsync" +sig = "Task OnInitializeAsync()" +returns = "Task" +file = "Services\\AsyncWorkersPool.cs" + +[[methods]] +parent = "AsyncWorkersPool" +name = "InitializePool" +sig = "void InitializePool(int poolSize)" +returns = "void" file = "Services\\AsyncWorkersPool.cs" [[classes]] name = "AsyncWorkersService" ns = "FEx.Asyncx.Services" -base = "AsyncInitializable - where TPool : AsyncWorkersPool - where TWorker : AsyncWorker - where TConf : IAsyncWorkerConfig" +base = "AsyncInitializable" +file = "Services\\AsyncWorkersService.cs" + +[[properties]] +parent = "AsyncWorkersService" +name = "Pool" +sig = "TPool Pool { get; set; }" +returns = "TPool" +file = "Services\\AsyncWorkersService.cs" + +[[properties]] +parent = "AsyncWorkersService" +name = "Config" +sig = "TConf Config { get; }" +returns = "TConf" +file = "Services\\AsyncWorkersService.cs" + +[[ctors]] +parent = "AsyncWorkersService" +sig = "AsyncWorkersService(uint poolSize, TConf config = default)" +file = "Services\\AsyncWorkersService.cs" + +[[methods]] +parent = "AsyncWorkersService" +name = "GetNewPool" +sig = "TPool GetNewPool(uint poolSize)" +returns = "TPool" +file = "Services\\AsyncWorkersService.cs" + +[[methods]] +parent = "AsyncWorkersService" +name = "OnConstruction" +sig = "void OnConstruction()" +returns = "void" file = "Services\\AsyncWorkersService.cs" [[classes]] @@ -89,9 +754,61 @@ ns = "FEx.Asyncx.Utilities" base = "TaskCompletionSource" file = "Utilities\\AsyncTaskCompletitionSource.cs" +[[ctors]] +parent = "AsyncTaskCompletionSource" +sig = "AsyncTaskCompletionSource()" +file = "Utilities\\AsyncTaskCompletitionSource.cs" + +[[ctors]] +parent = "AsyncTaskCompletionSource" +sig = "AsyncTaskCompletionSource(object state)" +file = "Utilities\\AsyncTaskCompletitionSource.cs" + [[classes]] name = "ManualResetEventAsync" ns = "FEx.Asyncx.Utilities" summary = "An async manual reset event." file = "Utilities\\ManualResetEventAsync.cs" +[[ctors]] +parent = "ManualResetEventAsync" +sig = "ManualResetEventAsync()" +summary = "Initializes a new instance of the class." +file = "Utilities\\ManualResetEventAsync.cs" + +[[ctors]] +parent = "ManualResetEventAsync" +sig = "ManualResetEventAsync(bool isSet, bool runSynchronousContinuationsOnSetThread)" +file = "Utilities\\ManualResetEventAsync.cs" + +[[methods]] +parent = "ManualResetEventAsync" +name = "WaitAsync" +sig = "Task WaitAsync()" +returns = "Task" +summary = "Wait for the manual reset event." +file = "Utilities\\ManualResetEventAsync.cs" + +[[methods]] +parent = "ManualResetEventAsync" +name = "WaitAsync" +sig = "Task WaitAsync(TimeSpan? timeout, CancellationToken token)" +returns = "Task" +file = "Utilities\\ManualResetEventAsync.cs" + +[[methods]] +parent = "ManualResetEventAsync" +name = "Set" +sig = "void Set()" +returns = "void" +summary = "Set the completion source." +file = "Utilities\\ManualResetEventAsync.cs" + +[[methods]] +parent = "ManualResetEventAsync" +name = "Reset" +sig = "void Reset()" +returns = "void" +summary = "Reset the manual reset event." +file = "Utilities\\ManualResetEventAsync.cs" + diff --git a/.api-surface/FEx/Avaloniax.toml b/.api-surface/FEx/Avaloniax.toml index 90ea2aa5..3bb037b5 100644 --- a/.api-surface/FEx/Avaloniax.toml +++ b/.api-surface/FEx/Avaloniax.toml @@ -8,12 +8,128 @@ ns = "FEx.Avaloniax" base = "FExDispatcher" file = "AvaloniaDispatcher.cs" +[[properties]] +parent = "AvaloniaDispatcher" +name = "Dispatcher" +sig = "static Dispatcher Dispatcher { get; }" +returns = "Dispatcher" +file = "AvaloniaDispatcher.cs" +static = true + +[[ctors]] +parent = "AvaloniaDispatcher" +sig = "AvaloniaDispatcher(ILogger logger, IMainThreadContextProvider mainThreadContextProvider, IDeadlockMonitor deadlockMonitor, IStackTraceProvider stackTraceProvider)" +file = "AvaloniaDispatcher.cs" + +[[methods]] +parent = "AvaloniaDispatcher" +name = "CheckAccess" +sig = "bool CheckAccess(object sender)" +returns = "bool" +file = "AvaloniaDispatcher.cs" + +[[methods]] +parent = "AvaloniaDispatcher" +name = "InvokeOnIdleMainThread" +sig = "void InvokeOnIdleMainThread(Action action, object sender)" +returns = "void" +file = "AvaloniaDispatcher.cs" + +[[methods]] +parent = "AvaloniaDispatcher" +name = "InvokeOnIdleMainThread" +sig = "T InvokeOnIdleMainThread(Func action, object sender)" +returns = "T" +file = "AvaloniaDispatcher.cs" + +[[methods]] +parent = "AvaloniaDispatcher" +name = "InvokeOnMainThread" +sig = "void InvokeOnMainThread(Action action, object sender)" +returns = "void" +file = "AvaloniaDispatcher.cs" + +[[methods]] +parent = "AvaloniaDispatcher" +name = "InvokeOnMainThread" +sig = "T InvokeOnMainThread(Func action, object sender)" +returns = "T" +file = "AvaloniaDispatcher.cs" + +[[methods]] +parent = "AvaloniaDispatcher" +name = "InvokeOnIdleMainThreadAsync" +sig = "Task InvokeOnIdleMainThreadAsync(Action action, object sender)" +returns = "Task" +file = "AvaloniaDispatcher.cs" + +[[methods]] +parent = "AvaloniaDispatcher" +name = "InvokeOnIdleMainThreadAsync" +sig = "Task InvokeOnIdleMainThreadAsync(Func action, object sender)" +returns = "Task" +file = "AvaloniaDispatcher.cs" + +[[methods]] +parent = "AvaloniaDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Action action, object sender)" +returns = "Task" +file = "AvaloniaDispatcher.cs" + +[[methods]] +parent = "AvaloniaDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func action, object sender)" +returns = "Task" +file = "AvaloniaDispatcher.cs" + +[[methods]] +parent = "AvaloniaDispatcher" +name = "BeginInvokeOnMainThread" +sig = "void BeginInvokeOnMainThread(Action action, object sender)" +returns = "void" +file = "AvaloniaDispatcher.cs" + +[[methods]] +parent = "AvaloniaDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func> funcTask, object sender)" +returns = "Task" +file = "AvaloniaDispatcher.cs" + +[[methods]] +parent = "AvaloniaDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func funcTask, object sender)" +returns = "Task" +file = "AvaloniaDispatcher.cs" + +[[methods]] +parent = "AvaloniaDispatcher" +name = "SendInContext" +sig = "void SendInContext(Action action, object sender, uint? timeout)" +returns = "void" +file = "AvaloniaDispatcher.cs" + [[classes]] name = "AvaloniaMessagePopupService" ns = "FEx.Avaloniax" base = "MessagePopupServiceBase" file = "AvaloniaMessagePopupService.cs" +[[ctors]] +parent = "AvaloniaMessagePopupService" +sig = "AvaloniaMessagePopupService(ILogger logger)" +file = "AvaloniaMessagePopupService.cs" + +[[methods]] +parent = "AvaloniaMessagePopupService" +name = "InternalShowMessageAsync" +sig = "Task InternalShowMessageAsync(string txt, string caption, MessageIcon messageBoxImage, FExMessageButton button, ISupportInitialize ownerWindow, bool informUser, bool wait, Stopwatch sw, LogLevel level, Exception exception)" +returns = "Task" +file = "AvaloniaMessagePopupService.cs" + [[classes]] name = "AvaloniaScheduler" ns = "FEx.Avaloniax" @@ -21,11 +137,67 @@ base = "LocalScheduler" summary = "Scheduler for ReactiveUI that marshals work to Avalonia's UI thread." file = "AvaloniaScheduler.cs" +[[properties]] +parent = "AvaloniaScheduler" +name = "Instance" +sig = "static AvaloniaScheduler Instance { get; }" +returns = "AvaloniaScheduler" +summary = "Gets the singleton instance of the Avalonia scheduler." +file = "AvaloniaScheduler.cs" +static = true + +[[methods]] +parent = "AvaloniaScheduler" +name = "Schedule" +sig = "IDisposable Schedule(TState state, TimeSpan dueTime, Func action)" +returns = "IDisposable" +file = "AvaloniaScheduler.cs" + [[classes]] name = "FExAvaloniaApp" ns = "FEx.Avaloniax" -base = "Application - where TContainer : class, IFExContainer, IDisposable, new()" +base = "Application" +file = "FExAvaloniaApp.cs" + +[[properties]] +parent = "FExAvaloniaApp" +name = "Container" +sig = "TContainer Container { get; }" +returns = "TContainer" +file = "FExAvaloniaApp.cs" + +[[ctors]] +parent = "FExAvaloniaApp" +sig = "FExAvaloniaApp()" +summary = "Initializes a new instance of the class." +file = "FExAvaloniaApp.cs" + +[[methods]] +parent = "FExAvaloniaApp" +name = "OnActivation" +sig = "void OnActivation()" +returns = "void" +file = "FExAvaloniaApp.cs" + +[[methods]] +parent = "FExAvaloniaApp" +name = "HandleCriticalException" +sig = "void HandleCriticalException(Exception ex)" +returns = "void" +file = "FExAvaloniaApp.cs" + +[[methods]] +parent = "FExAvaloniaApp" +name = "AppDomainUnhandledException" +sig = "void AppDomainUnhandledException(object sender, UnhandledExceptionEventArgs e)" +returns = "void" +file = "FExAvaloniaApp.cs" + +[[methods]] +parent = "FExAvaloniaApp" +name = "HandleAppException" +sig = "void HandleAppException(Exception exception)" +returns = "void" file = "FExAvaloniaApp.cs" [[classes]] @@ -35,6 +207,13 @@ base = "FExInitializable" summary = "Initializer for FEx.Avaloniax that configures ReactiveUI with Avalonia's UI scheduler." file = "FExAvaloniax.cs" +[[methods]] +parent = "FExAvaloniax" +name = "OnInitialize" +sig = "void OnInitialize()" +returns = "void" +file = "FExAvaloniax.cs" + [[classes]] name = "FExAvaloniaxModule" ns = "FEx.Avaloniax" @@ -46,45 +225,269 @@ ns = "FEx.Avaloniax" base = "InitializeModule" file = "FExModule.cs" +[[methods]] +parent = "FExModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExContainer container, IServiceCollection context)" +returns = "void" +file = "FExModule.cs" + [[classes]] name = "AsyncInitializableViewModelBase" ns = "FEx.Avaloniax.Abstractions" file = "Abstractions\\AsyncInitializableViewModelBase.AsyncInitializable.cs" +[[properties]] +parent = "AsyncInitializableViewModelBase" +name = "IsInitialized" +sig = "bool IsInitialized { get; set; }" +returns = "bool" +file = "Abstractions\\AsyncInitializableViewModelBase.AsyncInitializable.cs" + +[[properties]] +parent = "AsyncInitializableViewModelBase" +name = "HasFinishedInitialization" +sig = "bool HasFinishedInitialization { get; }" +returns = "bool" +file = "Abstractions\\AsyncInitializableViewModelBase.AsyncInitializable.cs" + +[[properties]] +parent = "AsyncInitializableViewModelBase" +name = "IsInitializing" +sig = "bool IsInitializing { get; }" +returns = "bool" +file = "Abstractions\\AsyncInitializableViewModelBase.AsyncInitializable.cs" + +[[properties]] +parent = "AsyncInitializableViewModelBase" +name = "TypeName" +sig = "string TypeName { get; set; }" +returns = "string" +file = "Abstractions\\AsyncInitializableViewModelBase.AsyncInitializable.cs" + +[[properties]] +parent = "AsyncInitializableViewModelBase" +name = "TypeFullName" +sig = "string TypeFullName { get; set; }" +returns = "string" +file = "Abstractions\\AsyncInitializableViewModelBase.AsyncInitializable.cs" + +[[properties]] +parent = "AsyncInitializableViewModelBase" +name = "SkipDependenciesInitialization" +sig = "bool SkipDependenciesInitialization { get; set; }" +returns = "bool" +summary = "If true doesn't wait for dependencies initialization" +file = "Abstractions\\AsyncInitializableViewModelBase.AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializableViewModelBase" +name = "InitializeAsync" +sig = "Task InitializeAsync()" +returns = "Task" +file = "Abstractions\\AsyncInitializableViewModelBase.AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializableViewModelBase" +name = "Reset" +sig = "void Reset()" +returns = "void" +file = "Abstractions\\AsyncInitializableViewModelBase.AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializableViewModelBase" +name = "BeginInitialization" +sig = "void BeginInitialization(bool waitSynchronouslyForInitialization)" +returns = "void" +file = "Abstractions\\AsyncInitializableViewModelBase.AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializableViewModelBase" +name = "BeginInitialization" +sig = "void BeginInitialization()" +returns = "void" +file = "Abstractions\\AsyncInitializableViewModelBase.AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializableViewModelBase" +name = "SafeInitializeAsync" +sig = "static Task> SafeInitializeAsync(IAsyncInitializable dependency)" +returns = "Task>" +file = "Abstractions\\AsyncInitializableViewModelBase.AsyncInitializable.cs" +static = true + +[[methods]] +parent = "AsyncInitializableViewModelBase" +name = "OnInitializeAsync" +sig = "Task OnInitializeAsync()" +returns = "Task" +file = "Abstractions\\AsyncInitializableViewModelBase.AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializableViewModelBase" +name = "InitializeDependenciesAsync" +sig = "Task InitializeDependenciesAsync()" +returns = "Task" +file = "Abstractions\\AsyncInitializableViewModelBase.AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializableViewModelBase" +name = "InitializeCoreAsync" +sig = "Task InitializeCoreAsync()" +returns = "Task" +file = "Abstractions\\AsyncInitializableViewModelBase.AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializableViewModelBase" +name = "ThrowIfNotInitialized" +sig = "void ThrowIfNotInitialized()" +returns = "void" +file = "Abstractions\\AsyncInitializableViewModelBase.AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializableViewModelBase" +name = "AddDependency" +sig = "void AddDependency(IAsyncInitializable dependency)" +returns = "void" +file = "Abstractions\\AsyncInitializableViewModelBase.AsyncInitializable.cs" + +[[methods]] +parent = "AsyncInitializableViewModelBase" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +file = "Abstractions\\AsyncInitializableViewModelBase.AsyncInitializable.cs" + [[classes]] name = "AsyncInitializableViewModelBase" ns = "FEx.Avaloniax.Abstractions" base = "FExAvaloniaViewModelBase, IAsyncInitializable" file = "Abstractions\\AsyncInitializableViewModelBase.cs" +[[ctors]] +parent = "AsyncInitializableViewModelBase" +sig = "AsyncInitializableViewModelBase(INavigationService navigationService, params IAsyncInitializable[] dependencies)" +file = "Abstractions\\AsyncInitializableViewModelBase.cs" + [[classes]] name = "FExAvaloniaReactiveUserControl" ns = "FEx.Avaloniax.Abstractions" -base = "ReactiveUserControl, IDisposable - where T : class, IActivatableViewModel" +base = "ReactiveUserControl, IDisposable" +file = "Abstractions\\FExAvaloniaReactiveUserControl.cs" + +[[ctors]] +parent = "FExAvaloniaReactiveUserControl" +sig = "FExAvaloniaReactiveUserControl()" +file = "Abstractions\\FExAvaloniaReactiveUserControl.cs" + +[[methods]] +parent = "FExAvaloniaReactiveUserControl" +name = "OnActivated" +sig = "void OnActivated()" +returns = "void" +file = "Abstractions\\FExAvaloniaReactiveUserControl.cs" + +[[methods]] +parent = "FExAvaloniaReactiveUserControl" +name = "OnDeactivated" +sig = "void OnDeactivated()" +returns = "void" +file = "Abstractions\\FExAvaloniaReactiveUserControl.cs" + +[[methods]] +parent = "FExAvaloniaReactiveUserControl" +name = "SubscribeToWhenActivated" +sig = "void SubscribeToWhenActivated()" +returns = "void" +file = "Abstractions\\FExAvaloniaReactiveUserControl.cs" + +[[methods]] +parent = "FExAvaloniaReactiveUserControl" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Abstractions\\FExAvaloniaReactiveUserControl.cs" + +[[methods]] +parent = "FExAvaloniaReactiveUserControl" +name = "ThrowIfDisposed" +sig = "void ThrowIfDisposed()" +returns = "void" file = "Abstractions\\FExAvaloniaReactiveUserControl.cs" [[classes]] name = "FExAvaloniaViewModelBase" ns = "FEx.Avaloniax.Abstractions" -base = "ReactiveNotifyPropertyChanged, IRoutableViewModel, - IActivatableViewModel, IDisposable" +base = "ReactiveNotifyPropertyChanged, IRoutableViewModel, IActivatableViewModel, IDisposable" file = "Abstractions\\FExAvaloniaViewModelBase.cs" -[[interfaces]] -name = "IFExAvaloniaContainer" -ns = "FEx.Avaloniax.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IFExAvaloniaContainer.cs" +[[properties]] +parent = "FExAvaloniaViewModelBase" +name = "UrlPathSegment" +sig = "string UrlPathSegment { get; }" +returns = "string" +file = "Abstractions\\FExAvaloniaViewModelBase.cs" -[[interfaces]] -name = "IFExContainer" -ns = "FEx.Avaloniax.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IFExContainer.cs" +[[properties]] +parent = "FExAvaloniaViewModelBase" +name = "HostScreen" +sig = "IScreen HostScreen { get; }" +returns = "IScreen" +file = "Abstractions\\FExAvaloniaViewModelBase.cs" -[[interfaces]] -name = "INavigationService" -ns = "FEx.Avaloniax.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\INavigationService.cs" +[[properties]] +parent = "FExAvaloniaViewModelBase" +name = "NavigationService" +sig = "INavigationService NavigationService { get; set; }" +returns = "INavigationService" +file = "Abstractions\\FExAvaloniaViewModelBase.cs" + +[[properties]] +parent = "FExAvaloniaViewModelBase" +name = "Activator" +sig = "ViewModelActivator Activator { get; }" +returns = "ViewModelActivator" +file = "Abstractions\\FExAvaloniaViewModelBase.cs" + +[[ctors]] +parent = "FExAvaloniaViewModelBase" +sig = "FExAvaloniaViewModelBase(INavigationService navigationService)" +file = "Abstractions\\FExAvaloniaViewModelBase.cs" + +[[methods]] +parent = "FExAvaloniaViewModelBase" +name = "OnDeactivated" +sig = "void OnDeactivated()" +returns = "void" +file = "Abstractions\\FExAvaloniaViewModelBase.cs" + +[[methods]] +parent = "FExAvaloniaViewModelBase" +name = "OnActivatedAsync" +sig = "Task OnActivatedAsync()" +returns = "Task" +file = "Abstractions\\FExAvaloniaViewModelBase.cs" + +[[methods]] +parent = "FExAvaloniaViewModelBase" +name = "ThrowIfDisposed" +sig = "void ThrowIfDisposed()" +returns = "void" +file = "Abstractions\\FExAvaloniaViewModelBase.cs" + +[[methods]] +parent = "FExAvaloniaViewModelBase" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Abstractions\\FExAvaloniaViewModelBase.cs" + +[[methods]] +parent = "FExAvaloniaViewModelBase" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +file = "Abstractions\\FExAvaloniaViewModelBase.cs" [[classes]] name = "FExDesktopWindow" @@ -92,20 +495,169 @@ ns = "FEx.Avaloniax.Desktop" base = "Window" file = "Desktop\\FExDesktopWindow.cs" +[[properties]] +parent = "FExDesktopWindow" +name = "TrayIcon" +sig = "FExTrayIcon TrayIcon { get; set; }" +returns = "FExTrayIcon" +file = "Desktop\\FExDesktopWindow.cs" + +[[methods]] +parent = "FExDesktopWindow" +name = "OnClosing" +sig = "void OnClosing(WindowClosingEventArgs e)" +returns = "void" +file = "Desktop\\FExDesktopWindow.cs" + [[classes]] name = "FExTrayIcon" ns = "FEx.Avaloniax.Desktop" file = "Desktop\\FExTrayIcon.cs" +[[ctors]] +parent = "FExTrayIcon" +sig = "FExTrayIcon(string toolTipText)" +file = "Desktop\\FExTrayIcon.cs" + +[[methods]] +parent = "FExTrayIcon" +name = "ExitApplication" +sig = "static void ExitApplication()" +returns = "void" +file = "Desktop\\FExTrayIcon.cs" +static = true + +[[methods]] +parent = "FExTrayIcon" +name = "Initialize" +sig = "void Initialize(WindowIcon icon)" +returns = "void" +file = "Desktop\\FExTrayIcon.cs" + +[[methods]] +parent = "FExTrayIcon" +name = "Show" +sig = "void Show()" +returns = "void" +file = "Desktop\\FExTrayIcon.cs" + +[[methods]] +parent = "FExTrayIcon" +name = "Hide" +sig = "void Hide()" +returns = "void" +file = "Desktop\\FExTrayIcon.cs" + +[[methods]] +parent = "FExTrayIcon" +name = "ShowMainWindow" +sig = "void ShowMainWindow()" +returns = "void" +file = "Desktop\\FExTrayIcon.cs" + [[classes]] name = "AppViewLocator" ns = "FEx.Avaloniax.Services" base = "IViewLocator" file = "Services\\AppViewLocator.cs" +[[properties]] +parent = "AppViewLocator" +name = "SupportsRecycling" +sig = "static bool SupportsRecycling { get; }" +returns = "bool" +file = "Services\\AppViewLocator.cs" +static = true + +[[methods]] +parent = "AppViewLocator" +name = "ResolveView" +sig = "IViewFor ResolveView(string contract = null) where TViewModel : class" +returns = "IViewFor" +file = "Services\\AppViewLocator.cs" + +[[methods]] +parent = "AppViewLocator" +name = "ResolveView" +sig = "IViewFor ResolveView(object viewModel, string contract = null)" +returns = "IViewFor" +file = "Services\\AppViewLocator.cs" + [[classes]] name = "NavigationService" ns = "FEx.Avaloniax.Services" base = "INavigationService" file = "Services\\NavigationService.cs" +[[properties]] +parent = "NavigationService" +name = "Router" +sig = "RoutingState Router { get; }" +returns = "RoutingState" +file = "Services\\NavigationService.cs" + +[[ctors]] +parent = "NavigationService" +sig = "NavigationService(IFExServiceProvider serviceProvider, IFExDispatcher dispatcher)" +file = "Services\\NavigationService.cs" + +[[methods]] +parent = "NavigationService" +name = "GoBackAsync" +sig = "Task GoBackAsync()" +returns = "Task" +file = "Services\\NavigationService.cs" + +[[methods]] +parent = "NavigationService" +name = "NavigateAsync" +sig = "Task NavigateAsync() where T : IRoutableViewModel" +returns = "Task" +file = "Services\\NavigationService.cs" + +[[methods]] +parent = "NavigationService" +name = "NavigateAndResetAsync" +sig = "Task NavigateAndResetAsync() where T : IRoutableViewModel" +returns = "Task" +file = "Services\\NavigationService.cs" + +[[interfaces]] +name = "IFExAvaloniaContainer" +ns = "FEx.Avaloniax.Abstractions.Interfaces" +base = "IContainer" +file = "Abstractions\\Interfaces\\IFExAvaloniaContainer.cs" + +[[interfaces]] +name = "IFExContainer" +ns = "FEx.Avaloniax.Abstractions.Interfaces" +base = "IFExBaseContainer, IFExMvvmContainer, IFExJsonContainer, IFExMvvmRxContainer, IFExPlatformsContainer, IFExAvaloniaContainer" +file = "Abstractions\\Interfaces\\IFExContainer.cs" + +[[interfaces]] +name = "INavigationService" +ns = "FEx.Avaloniax.Abstractions.Interfaces" +base = "IScreen" +file = "Abstractions\\Interfaces\\INavigationService.cs" + +[[methods]] +parent = "INavigationService" +name = "NavigateAsync" +sig = "Task NavigateAsync() where T : IRoutableViewModel" +returns = "Task" +file = "Abstractions\\Interfaces\\INavigationService.cs" + +[[methods]] +parent = "INavigationService" +name = "NavigateAndResetAsync" +sig = "Task NavigateAndResetAsync() where T : IRoutableViewModel" +returns = "Task" +file = "Abstractions\\Interfaces\\INavigationService.cs" + +[[methods]] +parent = "INavigationService" +name = "GoBackAsync" +sig = "Task GoBackAsync()" +returns = "Task" +file = "Abstractions\\Interfaces\\INavigationService.cs" + diff --git a/.api-surface/FEx/AzureDevOpsx.toml b/.api-surface/FEx/AzureDevOpsx.toml index 4b1d7183..8488a7c5 100644 --- a/.api-surface/FEx/AzureDevOpsx.toml +++ b/.api-surface/FEx/AzureDevOpsx.toml @@ -13,6 +13,85 @@ ns = "FEx.AzureDevOpsx" base = "IDisposable" file = "FuncProcessor.cs" +[[properties]] +parent = "FuncProcessor" +name = "RateLimits" +sig = "static ConcurrentDictionary RateLimits { get; }" +returns = "ConcurrentDictionary" +file = "FuncProcessor.cs" +static = true + +[[properties]] +parent = "FuncProcessor" +name = "ExpectedContentType" +sig = "static string ExpectedContentType { get; }" +returns = "string" +file = "FuncProcessor.cs" +static = true + +[[properties]] +parent = "FuncProcessor" +name = "Method" +sig = "RequestMethod Method { get; }" +returns = "RequestMethod" +file = "FuncProcessor.cs" + +[[properties]] +parent = "FuncProcessor" +name = "CancellationTokenSource" +sig = "CancellationTokenSource CancellationTokenSource { get; }" +returns = "CancellationTokenSource" +file = "FuncProcessor.cs" + +[[ctors]] +parent = "FuncProcessor" +sig = "FuncProcessor(string serverUrl, string scriptPath, ICredentials credentials, string environmentId, IDictionary args = null, RequestMethod method = RequestMethod.GET)" +file = "FuncProcessor.cs" + +[[ctors]] +parent = "FuncProcessor" +sig = "FuncProcessor(string serverUrl, string scriptPath, ICredentials credentials, IDictionary args = null, RequestMethod method = RequestMethod.GET)" +file = "FuncProcessor.cs" + +[[ctors]] +parent = "FuncProcessor" +sig = "FuncProcessor(string requestUrl, ICredentials credentials, IDictionary args = null, RequestMethod method = RequestMethod.GET)" +file = "FuncProcessor.cs" + +[[ctors]] +parent = "FuncProcessor" +sig = "FuncProcessor(string requestUrl, ICredentials credentials, string environmentId, IDictionary args = null, RequestMethod method = RequestMethod.GET)" +file = "FuncProcessor.cs" + +[[methods]] +parent = "FuncProcessor" +name = "ProcessResponse" +sig = "static TResponse ProcessResponse(string response, JsonSerializerSettings settings = null) where TResponse : BaseTfsResponse, new()" +returns = "TResponse" +file = "FuncProcessor.cs" +static = true + +[[methods]] +parent = "FuncProcessor" +name = "RunAsync" +sig = "Task RunAsync(JsonSerializerSettings settings = null, IList omitCodes = null) where TResponse : BaseTfsResponse, new()" +returns = "Task" +file = "FuncProcessor.cs" + +[[methods]] +parent = "FuncProcessor" +name = "RunRawAsync" +sig = "Task RunRawAsync(IList omitCodes = null)" +returns = "Task" +file = "FuncProcessor.cs" + +[[methods]] +parent = "FuncProcessor" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "FuncProcessor.cs" + [[classes]] name = "Project" ns = "FEx.AzureDevOpsx" @@ -20,6 +99,245 @@ base = "NotifyPropertyChanged" summary = "Container for TFS project properties https://www.visualstudio.com/en-us/docs/integrate/api/tfs/projects" file = "Project.cs" +[[properties]] +parent = "Project" +name = "IsWorkspacePresent" +sig = "bool IsWorkspacePresent { get; }" +returns = "bool" +summary = "Gets a value indicating whether this instance is workspace present." +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "ProjectWorkspaces" +sig = "List ProjectWorkspaces { get; set; }" +returns = "List" +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "DefaultTeamUrl" +sig = "Uri DefaultTeamUrl { get; }" +returns = "Uri" +summary = "URL of project default team." +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "Server" +sig = "TfsConfigurationServer Server { get; }" +returns = "TfsConfigurationServer" +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "DefaultTeamId" +sig = "string DefaultTeamId { get; set; }" +returns = "string" +summary = "ID of project default team." +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "DefaultTeamName" +sig = "string DefaultTeamName { get; set; }" +returns = "string" +summary = "Name of project default team." +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "WebUrl" +sig = "Uri WebUrl { get; set; }" +returns = "Uri" +summary = "URL of project dashboard site." +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "Id" +sig = "string Id { get; set; }" +returns = "string" +summary = "ID ( ) of the project." +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "Name" +sig = "string Name { get; set; }" +returns = "string" +summary = "Name of the project." +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "Description" +sig = "string Description { get; set; }" +returns = "string" +summary = "Description of the project." +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "ApiUrl" +sig = "Uri ApiUrl { get; set; }" +returns = "Uri" +summary = "Base TFS REST API URL of the project." +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "StateString" +sig = "string StateString { get; set; }" +returns = "string" +summary = "State of the project." +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "State" +sig = "ProjectState State { get; }" +returns = "ProjectState" +summary = "State of the project." +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "SourceControlTypeString" +sig = "string SourceControlTypeString { get; set; }" +returns = "string" +summary = "Source control type of the project." +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "SourceControlType" +sig = "SourceControlTypes SourceControlType { get; }" +returns = "SourceControlTypes" +summary = "Source control type of the project." +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "ProcessTemplateName" +sig = "string ProcessTemplateName { get; set; }" +returns = "string" +summary = "Process template name of the project." +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "Collection" +sig = "ProjectsCollection Collection { get; set; }" +returns = "ProjectsCollection" +summary = "Collection name of the project." +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "CollectionName" +sig = "string CollectionName { get; }" +returns = "string" +summary = "Collection name of the project." +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "CodeSite" +sig = "Uri CodeSite { get; }" +returns = "Uri" +summary = "URL of project code explorer site." +file = "Project.cs" + +[[properties]] +parent = "Project" +name = "IdOfRepo" +sig = "string IdOfRepo { get; }" +returns = "string" +summary = "ID of Git project repository." +file = "Project.cs" + +[[ctors]] +parent = "Project" +sig = "Project()" +summary = "Initializes new class instance." +file = "Project.cs" + +[[methods]] +parent = "Project" +name = "RefreshAsync" +sig = "Task RefreshAsync()" +returns = "Task" +file = "Project.cs" + +[[methods]] +parent = "Project" +name = "GetFileHyperlinkAsync" +sig = "Task GetFileHyperlinkAsync(string serverItem)" +returns = "Task" +summary = "Gets the file hyperlink." +file = "Project.cs" + +[[methods]] +parent = "Project" +name = "GetFileContentAsync" +sig = "Task GetFileContentAsync(string serverItem)" +returns = "Task" +summary = "Gets contents of file at specified path in specified project." +file = "Project.cs" + +[[methods]] +parent = "Project" +name = "TfvcGetFileContentAsync" +sig = "Task TfvcGetFileContentAsync(string serverItem)" +returns = "Task" +file = "Project.cs" + +[[methods]] +parent = "Project" +name = "GitGetFileContentAsync" +sig = "Task GitGetFileContentAsync(string serverItem)" +returns = "Task" +file = "Project.cs" + +[[methods]] +parent = "Project" +name = "GitGetFileInfoAsync" +sig = "Task GitGetFileInfoAsync(string serverItem)" +returns = "Task" +file = "Project.cs" + +[[methods]] +parent = "Project" +name = "SaveFileContentAsync" +sig = "Task SaveFileContentAsync(string serverItem, string fileContent, string comment = \"\")" +returns = "Task" +summary = "Updates file at specified path with provided content." +file = "Project.cs" + +[[methods]] +parent = "Project" +name = "GetLastCheckinAsync" +sig = "Task GetLastCheckinAsync()" +returns = "Task" +file = "Project.cs" + +[[methods]] +parent = "Project" +name = "UpdateProjectNameAsync" +sig = "Task UpdateProjectNameAsync(string newName)" +returns = "Task" +summary = "Updates the name of the project." +file = "Project.cs" + +[[methods]] +parent = "Project" +name = "UpdateProjectDescriptionAsync" +sig = "Task UpdateProjectDescriptionAsync(string newDescription)" +returns = "Task" +summary = "Updates the project description." +file = "Project.cs" + [[classes]] name = "ProjectsCollection" ns = "FEx.AzureDevOpsx" @@ -27,6 +345,195 @@ base = "NotifyPropertyChanged, IDisposable" summary = "Container for TFS projects collection properties https://www.visualstudio.com/en-us/docs/integrate/api/tfs/project-collections" file = "ProjectsCollection.cs" +[[properties]] +parent = "ProjectsCollection" +name = "IsChecked" +sig = "bool IsChecked { get; set; }" +returns = "bool" +file = "ProjectsCollection.cs" + +[[properties]] +parent = "ProjectsCollection" +name = "IsEnabled" +sig = "bool IsEnabled { get; }" +returns = "bool" +file = "ProjectsCollection.cs" + +[[properties]] +parent = "ProjectsCollection" +name = "Projects" +sig = "ConcurrentObservableList Projects { get; }" +returns = "ConcurrentObservableList" +summary = "Gets the projects." +file = "ProjectsCollection.cs" + +[[properties]] +parent = "ProjectsCollection" +name = "Shelvesets" +sig = "ConcurrentObservableList Shelvesets { get; }" +returns = "ConcurrentObservableList" +summary = "Gets or sets the shelvesets." +file = "ProjectsCollection.cs" + +[[properties]] +parent = "ProjectsCollection" +name = "IsIdle" +sig = "bool IsIdle { get; set; }" +returns = "bool" +file = "ProjectsCollection.cs" + +[[properties]] +parent = "ProjectsCollection" +name = "Workspaces" +sig = "ConcurrentObservableList Workspaces { get; }" +returns = "ConcurrentObservableList" +summary = "Gets the workspaces." +file = "ProjectsCollection.cs" + +[[properties]] +parent = "ProjectsCollection" +name = "CollectionNameForRequests" +sig = "string CollectionNameForRequests { get; }" +returns = "string" +file = "ProjectsCollection.cs" + +[[properties]] +parent = "ProjectsCollection" +name = "Name" +sig = "string Name { get; }" +returns = "string" +summary = "Gets the name." +file = "ProjectsCollection.cs" + +[[properties]] +parent = "ProjectsCollection" +name = "Description" +sig = "string Description { get; }" +returns = "string" +summary = "Gets the description." +file = "ProjectsCollection.cs" + +[[properties]] +parent = "ProjectsCollection" +name = "Identifier" +sig = "Guid Identifier { get; }" +returns = "Guid" +summary = "Gets the identifier." +file = "ProjectsCollection.cs" + +[[properties]] +parent = "ProjectsCollection" +name = "CollectionNode" +sig = "CatalogNode CollectionNode { get; }" +returns = "CatalogNode" +summary = "Gets or sets the collection node." +file = "ProjectsCollection.cs" + +[[properties]] +parent = "ProjectsCollection" +name = "Url" +sig = "Uri Url { get; }" +returns = "Uri" +summary = "Gets the URL." +file = "ProjectsCollection.cs" + +[[properties]] +parent = "ProjectsCollection" +name = "TfsTeamProjectCollection" +sig = "TfsTeamProjectCollection TfsTeamProjectCollection { get; }" +returns = "TfsTeamProjectCollection" +file = "ProjectsCollection.cs" + +[[ctors]] +parent = "ProjectsCollection" +sig = "ProjectsCollection(CatalogNode collectionNode, TfsEnvironment environment, string collectionNameForRequests)" +summary = "Initializes new class instance." +file = "ProjectsCollection.cs" + +[[methods]] +parent = "ProjectsCollection" +name = "RefreshCollectionAsync" +sig = "Task RefreshCollectionAsync()" +returns = "Task" +summary = "Refreshes the collection." +file = "ProjectsCollection.cs" + +[[methods]] +parent = "ProjectsCollection" +name = "RefreshTfsCollectionProjectsAsync" +sig = "Task RefreshTfsCollectionProjectsAsync(IProgress prg = null)" +returns = "Task" +summary = "Refreshes information about all projects from provided collection." +file = "ProjectsCollection.cs" + +[[methods]] +parent = "ProjectsCollection" +name = "DownloadShelvesetAsync" +sig = "Task DownloadShelvesetAsync(string rootDirectory, string id, IProgressAggregator viewModel)" +returns = "Task" +summary = "Downloads the shelveset." +file = "ProjectsCollection.cs" + +[[methods]] +parent = "ProjectsCollection" +name = "GetShelvesetsAsync" +sig = "Task GetShelvesetsAsync(bool refresh = true)" +returns = "Task" +file = "ProjectsCollection.cs" + +[[methods]] +parent = "ProjectsCollection" +name = "GetRequestResultAsync" +sig = "Task GetRequestResultAsync(string requestUrl, bool resultAsJson = true, List omitCodes = null, string afterCollectionName = \"\", List cookies = null)" +returns = "Task" +summary = "Handles GET requests." +file = "ProjectsCollection.cs" + +[[methods]] +parent = "ProjectsCollection" +name = "RunProcAsync" +sig = "Task RunProcAsync(string scriptPath, IDictionary args = null, JsonSerializerSettings settings = null, IList omitCodes = null, RequestMethod method = RequestMethod.GET) where TResponse : BaseTfsResponse, new()" +returns = "Task" +file = "ProjectsCollection.cs" + +[[methods]] +parent = "ProjectsCollection" +name = "RunProcAsync" +sig = "Task RunProcAsync(string scriptPath, IDictionary args = null, IList omitCodes = null, RequestMethod method = RequestMethod.GET)" +returns = "Task" +file = "ProjectsCollection.cs" + +[[methods]] +parent = "ProjectsCollection" +name = "PostRequestResultAsync" +sig = "Task PostRequestResultAsync(string requestUrl, string postContent, List omitCodes = null, List cookies = null)" +returns = "Task" +summary = "Handles POST requests." +file = "ProjectsCollection.cs" + +[[methods]] +parent = "ProjectsCollection" +name = "PatchRequestResultAsync" +sig = "Task PatchRequestResultAsync(string requestUrl, string patchContent, List omitCodes = null, List cookies = null)" +returns = "Task" +summary = "Handles PATCH requests." +file = "ProjectsCollection.cs" + +[[methods]] +parent = "ProjectsCollection" +name = "DownloadFileFromUrlAsync" +sig = "Task DownloadFileFromUrlAsync(string rootDirectory, Uri url, string serverPath, ICredentials credentials, IProgressAggregator viewModel)" +returns = "Task" +summary = "Downloads the file from URL." +file = "ProjectsCollection.cs" + +[[methods]] +parent = "ProjectsCollection" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "ProjectsCollection.cs" + [[enums]] name = "TfsBuildServerVersion" ns = "FEx.AzureDevOpsx" @@ -37,12 +544,265 @@ name = "TfsChangeset" ns = "FEx.AzureDevOpsx" file = "TfsChangeset.cs" +[[properties]] +parent = "TfsChangeset" +name = "ChangesetId" +sig = "string ChangesetId { get; set; }" +returns = "string" +file = "TfsChangeset.cs" + +[[properties]] +parent = "TfsChangeset" +name = "Committer" +sig = "string Committer { get; set; }" +returns = "string" +file = "TfsChangeset.cs" + +[[properties]] +parent = "TfsChangeset" +name = "CommitterDisplayName" +sig = "string CommitterDisplayName { get; set; }" +returns = "string" +file = "TfsChangeset.cs" + +[[properties]] +parent = "TfsChangeset" +name = "CreationDate" +sig = "DateTime CreationDate { get; set; }" +returns = "DateTime" +file = "TfsChangeset.cs" + +[[properties]] +parent = "TfsChangeset" +name = "ChangesetUrl" +sig = "Uri ChangesetUrl { get; set; }" +returns = "Uri" +file = "TfsChangeset.cs" + +[[ctors]] +parent = "TfsChangeset" +sig = "TfsChangeset()" +file = "TfsChangeset.cs" + [[classes]] name = "TfsEnvironment" ns = "FEx.AzureDevOpsx" base = "NotifyPropertyChanged" file = "TfsEnvironment.cs" +[[properties]] +parent = "TfsEnvironment" +name = "EnvironmentId" +sig = "string EnvironmentId { get; }" +returns = "string" +file = "TfsEnvironment.cs" + +[[properties]] +parent = "TfsEnvironment" +name = "ProgressViewModel" +sig = "IProgressAggregator ProgressViewModel { get; }" +returns = "IProgressAggregator" +file = "TfsEnvironment.cs" + +[[properties]] +parent = "TfsEnvironment" +name = "ImagesCacheDirPath" +sig = "string ImagesCacheDirPath { get; }" +returns = "string" +file = "TfsEnvironment.cs" + +[[properties]] +parent = "TfsEnvironment" +name = "DisplayName" +sig = "string DisplayName { get; }" +returns = "string" +file = "TfsEnvironment.cs" + +[[properties]] +parent = "TfsEnvironment" +name = "LoadingProjectsCollections" +sig = "bool LoadingProjectsCollections { get; }" +returns = "bool" +file = "TfsEnvironment.cs" + +[[properties]] +parent = "TfsEnvironment" +name = "SuccessfullyAuthenticated" +sig = "EventHandler SuccessfullyAuthenticated { get; set; }" +returns = "EventHandler" +file = "TfsEnvironment.cs" + +[[properties]] +parent = "TfsEnvironment" +name = "Name" +sig = "string Name { get; }" +returns = "string" +file = "TfsEnvironment.cs" + +[[properties]] +parent = "TfsEnvironment" +name = "Version" +sig = "string Version { get; }" +returns = "string" +file = "TfsEnvironment.cs" + +[[properties]] +parent = "TfsEnvironment" +name = "Server" +sig = "TfsConfigurationServer Server { get; }" +returns = "TfsConfigurationServer" +file = "TfsEnvironment.cs" + +[[properties]] +parent = "TfsEnvironment" +name = "ServerUri" +sig = "Uri ServerUri { get; }" +returns = "Uri" +summary = "Gets or sets the server URI." +file = "TfsEnvironment.cs" + +[[properties]] +parent = "TfsEnvironment" +name = "IsConnecting" +sig = "bool IsConnecting { get; }" +returns = "bool" +file = "TfsEnvironment.cs" + +[[properties]] +parent = "TfsEnvironment" +name = "UserName" +sig = "string UserName { get; }" +returns = "string" +summary = "Gets or sets the name of the user." +file = "TfsEnvironment.cs" + +[[properties]] +parent = "TfsEnvironment" +name = "Password" +sig = "string Password { get; }" +returns = "string" +summary = "Gets or sets the password." +file = "TfsEnvironment.cs" + +[[properties]] +parent = "TfsEnvironment" +name = "UserInfo" +sig = "AuthenticatedUserInfo UserInfo { get; }" +returns = "AuthenticatedUserInfo" +file = "TfsEnvironment.cs" + +[[properties]] +parent = "TfsEnvironment" +name = "ProjectsCollections" +sig = "ConcurrentList ProjectsCollections { get; }" +returns = "ConcurrentList" +file = "TfsEnvironment.cs" + +[[ctors]] +parent = "TfsEnvironment" +sig = "TfsEnvironment(string name, Uri address, IProgressAggregator viewModel, string imagesCacheDirPath)" +summary = "Initializes a new instance of the class." +file = "TfsEnvironment.cs" + +[[ctors]] +parent = "TfsEnvironment" +sig = "TfsEnvironment(string name, string address, IProgressAggregator viewModel, string imagesCacheDirPath)" +summary = "Initializes a new instance of the class." +file = "TfsEnvironment.cs" + +[[methods]] +parent = "TfsEnvironment" +name = "InitializeAsync" +sig = "Task InitializeAsync(bool autoLogIn = true, string username = null, string password = null)" +returns = "Task" +file = "TfsEnvironment.cs" + +[[methods]] +parent = "TfsEnvironment" +name = "GetServerAsync" +sig = "Task GetServerAsync(bool autoLogIn = true, string username = null, string password = null)" +returns = "Task" +summary = "Gets the server." +file = "TfsEnvironment.cs" + +[[methods]] +parent = "TfsEnvironment" +name = "GetVssCredentials" +sig = "VssCredentials GetVssCredentials(bool forceDefault = false)" +returns = "VssCredentials" +file = "TfsEnvironment.cs" + +[[methods]] +parent = "TfsEnvironment" +name = "GetCredentials" +sig = "ICredentials GetCredentials(bool forceDefault = false)" +returns = "ICredentials" +file = "TfsEnvironment.cs" + +[[methods]] +parent = "TfsEnvironment" +name = "GetCurrentUserName" +sig = "string GetCurrentUserName(string separator = \" \")" +returns = "string" +summary = "Gets the name of the current user." +file = "TfsEnvironment.cs" + +[[methods]] +parent = "TfsEnvironment" +name = "LoginAsync" +sig = "Task LoginAsync(string username = null, string password = null)" +returns = "Task" +file = "TfsEnvironment.cs" + +[[methods]] +parent = "TfsEnvironment" +name = "GetBuildServerVersionAsync" +sig = "Task GetBuildServerVersionAsync()" +returns = "Task" +file = "TfsEnvironment.cs" + +[[methods]] +parent = "TfsEnvironment" +name = "GetProjectsCollectionsAsync" +sig = "Task GetProjectsCollectionsAsync()" +returns = "Task" +file = "TfsEnvironment.cs" + +[[methods]] +parent = "TfsEnvironment" +name = "GetProjectsCollections" +sig = "ConcurrentList GetProjectsCollections()" +returns = "ConcurrentList" +file = "TfsEnvironment.cs" + +[[methods]] +parent = "TfsEnvironment" +name = "EnsureProjectsCollectionsCacheAsync" +sig = "Task EnsureProjectsCollectionsCacheAsync()" +returns = "Task" +file = "TfsEnvironment.cs" + +[[methods]] +parent = "TfsEnvironment" +name = "GetProfileImageAsync" +sig = "Task GetProfileImageAsync()" +returns = "Task" +file = "TfsEnvironment.cs" + +[[methods]] +parent = "TfsEnvironment" +name = "RunProcAsync" +sig = "Task RunProcAsync(string requestUrl, IDictionary args = null, JsonSerializerSettings settings = null, IList omitCodes = null, RequestMethod method = RequestMethod.GET) where TResponse : BaseTfsResponse, new()" +returns = "Task" +file = "TfsEnvironment.cs" + +[[methods]] +parent = "TfsEnvironment" +name = "RunRawAsync" +sig = "Task RunRawAsync(string requestUrl, IDictionary args = null, IList omitCodes = null, RequestMethod method = RequestMethod.GET)" +returns = "Task" +file = "TfsEnvironment.cs" + [[classes]] name = "TfsWebApi" ns = "FEx.AzureDevOpsx" @@ -55,84 +815,460 @@ name = "ChangeItem" ns = "FEx.AzureDevOpsx.Entities" file = "Entities\\ChangeItem.cs" +[[properties]] +parent = "ChangeItem" +name = "Version" +sig = "long? Version { get; set; }" +returns = "long?" +file = "Entities\\ChangeItem.cs" + +[[properties]] +parent = "ChangeItem" +name = "HashValue" +sig = "string HashValue { get; set; }" +returns = "string" +file = "Entities\\ChangeItem.cs" + +[[properties]] +parent = "ChangeItem" +name = "Path" +sig = "string Path { get; set; }" +returns = "string" +file = "Entities\\ChangeItem.cs" + +[[properties]] +parent = "ChangeItem" +name = "Url" +sig = "Uri Url { get; set; }" +returns = "Uri" +file = "Entities\\ChangeItem.cs" + +[[properties]] +parent = "ChangeItem" +name = "IsFolder" +sig = "bool? IsFolder { get; set; }" +returns = "bool?" +file = "Entities\\ChangeItem.cs" + [[classes]] name = "HrefUrl" ns = "FEx.AzureDevOpsx.Entities" file = "Entities\\HrefUrl.cs" +[[properties]] +parent = "HrefUrl" +name = "Href" +sig = "Uri Href { get; set; }" +returns = "Uri" +file = "Entities\\HrefUrl.cs" + [[classes]] name = "Links" ns = "FEx.AzureDevOpsx.Entities" file = "Entities\\Links.cs" +[[properties]] +parent = "Links" +name = "Self" +sig = "HrefUrl Self { get; set; }" +returns = "HrefUrl" +file = "Entities\\Links.cs" + +[[properties]] +parent = "Links" +name = "Changes" +sig = "HrefUrl Changes { get; set; }" +returns = "HrefUrl" +file = "Entities\\Links.cs" + +[[properties]] +parent = "Links" +name = "WorkItems" +sig = "HrefUrl WorkItems { get; set; }" +returns = "HrefUrl" +file = "Entities\\Links.cs" + +[[properties]] +parent = "Links" +name = "Owner" +sig = "HrefUrl Owner { get; set; }" +returns = "HrefUrl" +file = "Entities\\Links.cs" + [[classes]] name = "Owner" ns = "FEx.AzureDevOpsx.Entities" base = "NotifyPropertyChanged" file = "Entities\\Owner.cs" +[[properties]] +parent = "Owner" +name = "EnvironmentId" +sig = "string EnvironmentId { get; set; }" +returns = "string" +file = "Entities\\Owner.cs" + +[[properties]] +parent = "Owner" +name = "Id" +sig = "string Id { get; set; }" +returns = "string" +file = "Entities\\Owner.cs" + +[[properties]] +parent = "Owner" +name = "DisplayName" +sig = "string DisplayName { get; set; }" +returns = "string" +file = "Entities\\Owner.cs" + +[[properties]] +parent = "Owner" +name = "UniqueName" +sig = "string UniqueName { get; set; }" +returns = "string" +file = "Entities\\Owner.cs" + +[[properties]] +parent = "Owner" +name = "Url" +sig = "Uri Url { get; set; }" +returns = "Uri" +file = "Entities\\Owner.cs" + +[[properties]] +parent = "Owner" +name = "ImageUrl" +sig = "Uri ImageUrl { get; set; }" +returns = "Uri" +summary = "Gets or sets the owner image URL." +file = "Entities\\Owner.cs" + +[[properties]] +parent = "Owner" +name = "Image" +sig = "ImageSource Image { get; }" +returns = "ImageSource" +file = "Entities\\Owner.cs" + +[[methods]] +parent = "Owner" +name = "RefreshImage" +sig = "void RefreshImage()" +returns = "void" +file = "Entities\\Owner.cs" + +[[methods]] +parent = "Owner" +name = "RefreshImageAsync" +sig = "Task RefreshImageAsync(TfsEnvironment env)" +returns = "Task" +file = "Entities\\Owner.cs" + [[classes]] name = "ShelvesetChange" ns = "FEx.AzureDevOpsx.Entities" file = "Entities\\ShelvesetChange.cs" +[[properties]] +parent = "ShelvesetChange" +name = "Item" +sig = "ChangeItem Item { get; set; }" +returns = "ChangeItem" +file = "Entities\\ShelvesetChange.cs" + +[[properties]] +parent = "ShelvesetChange" +name = "ChangeTypeString" +sig = "string ChangeTypeString { get; set; }" +returns = "string" +file = "Entities\\ShelvesetChange.cs" + +[[properties]] +parent = "ShelvesetChange" +name = "SourceServerItem" +sig = "string SourceServerItem { get; set; }" +returns = "string" +file = "Entities\\ShelvesetChange.cs" + +[[properties]] +parent = "ShelvesetChange" +name = "Type" +sig = "ChangeType Type { get; }" +returns = "ChangeType" +file = "Entities\\ShelvesetChange.cs" + [[classes]] name = "ShelvesetContent" ns = "FEx.AzureDevOpsx.Entities" base = "NotifyPropertyChanged" file = "Entities\\ShelvesetContent.cs" +[[properties]] +parent = "ShelvesetContent" +name = "EnvironmentId" +sig = "string EnvironmentId { get; set; }" +returns = "string" +file = "Entities\\ShelvesetContent.cs" + +[[properties]] +parent = "ShelvesetContent" +name = "Changes" +sig = "ConcurrentObservableList Changes { get; set; }" +returns = "ConcurrentObservableList" +file = "Entities\\ShelvesetContent.cs" + +[[properties]] +parent = "ShelvesetContent" +name = "Name" +sig = "string Name { get; set; }" +returns = "string" +file = "Entities\\ShelvesetContent.cs" + +[[properties]] +parent = "ShelvesetContent" +name = "Id" +sig = "string Id { get; set; }" +returns = "string" +file = "Entities\\ShelvesetContent.cs" + +[[properties]] +parent = "ShelvesetContent" +name = "Owner" +sig = "Owner Owner { get; set; }" +returns = "Owner" +file = "Entities\\ShelvesetContent.cs" + +[[properties]] +parent = "ShelvesetContent" +name = "CreatedDate" +sig = "DateTimeOffset CreatedDate { get; set; }" +returns = "DateTimeOffset" +file = "Entities\\ShelvesetContent.cs" + +[[properties]] +parent = "ShelvesetContent" +name = "Url" +sig = "Uri Url { get; set; }" +returns = "Uri" +file = "Entities\\ShelvesetContent.cs" + +[[properties]] +parent = "ShelvesetContent" +name = "Comment" +sig = "string Comment { get; set; }" +returns = "string" +file = "Entities\\ShelvesetContent.cs" + +[[properties]] +parent = "ShelvesetContent" +name = "Links" +sig = "Links Links { get; set; }" +returns = "Links" +file = "Entities\\ShelvesetContent.cs" + +[[methods]] +parent = "ShelvesetContent" +name = "LoadChangesAsync" +sig = "Task LoadChangesAsync()" +returns = "Task" +file = "Entities\\ShelvesetContent.cs" + [[classes]] name = "TfsExtensions" ns = "FEx.AzureDevOpsx.Extensions" file = "Extensions\\TfsExtensions.cs" static = true +[[properties]] +parent = "TfsExtensions" +name = "ChangeTypes" +sig = "static Dictionary ChangeTypes { get; }" +returns = "Dictionary" +file = "Extensions\\TfsExtensions.cs" +static = true + +[[properties]] +parent = "TfsExtensions" +name = "SourceControlTypes" +sig = "static Dictionary SourceControlTypes { get; }" +returns = "Dictionary" +file = "Extensions\\TfsExtensions.cs" +static = true + +[[properties]] +parent = "TfsExtensions" +name = "ProjectStates" +sig = "static Dictionary ProjectStates { get; }" +returns = "Dictionary" +file = "Extensions\\TfsExtensions.cs" +static = true + [[extensions]] name = "GetBuildServerVersion" -sig = "TfsBuildServerVersion GetBuildServerVersion(this IBuildServer buildServer)" returns = "TfsBuildServerVersion" +sig = "TfsBuildServerVersion GetBuildServerVersion(this IBuildServer buildServer)" file = "Extensions\\TfsExtensions.cs" [[extensions]] name = "GetServerVersionDescription" -sig = "string GetServerVersionDescription(this TfsBuildServerVersion buildServerVersion)" returns = "string" +sig = "string GetServerVersionDescription(this TfsBuildServerVersion buildServerVersion)" file = "Extensions\\TfsExtensions.cs" [[extensions]] name = "GetProjectWorkspaces" -sig = "List GetProjectWorkspaces(this Project project)" returns = "List" +sig = "List GetProjectWorkspaces(this Project project)" file = "Extensions\\TfsExtensions.cs" [[extensions]] name = "GetTeamProjectCollection" +returns = "TfsTeamProjectCollection" sig = "TfsTeamProjectCollection GetTeamProjectCollection(this CatalogNode collectionNode, TfsConfigurationServer server)" +file = "Extensions\\TfsExtensions.cs" + +[[methods]] +parent = "TfsExtensions" +name = "GetTeamProjectCollection" +sig = "static TfsTeamProjectCollection GetTeamProjectCollection(string instanceId, TfsConfigurationServer server)" returns = "TfsTeamProjectCollection" file = "Extensions\\TfsExtensions.cs" +static = true [[extensions]] name = "GetCurrentUserName" -sig = "string GetCurrentUserName(this TfsConfigurationServer server, string separator = \" \")" returns = "string" +sig = "string GetCurrentUserName(this TfsConfigurationServer server, string separator = \" \")" summary = "Gets the name of the current user." file = "Extensions\\TfsExtensions.cs" +[[methods]] +parent = "TfsExtensions" +name = "LoadImageAsync" +sig = "static Task LoadImageAsync(Uri imageUrl, ICredentials credentials, SemaphoreSlim rateLimit = null)" +returns = "Task" +file = "Extensions\\TfsExtensions.cs" +static = true + +[[methods]] +parent = "TfsExtensions" +name = "SaveFileContent" +sig = "static bool SaveFileContent(string serverItem, Project project, string fileContent, string checkinComment = \"\")" +returns = "bool" +file = "Extensions\\TfsExtensions.cs" +static = true + [[classes]] name = "BaseTfsResponse" ns = "FEx.AzureDevOpsx.Responses" file = "Responses\\BaseTFSResponse.cs" +[[properties]] +parent = "BaseTfsResponse" +name = "Count" +sig = "long Count { get; set; }" +returns = "long" +file = "Responses\\BaseTFSResponse.cs" + [[classes]] name = "ShelvesetResponse" ns = "FEx.AzureDevOpsx.Responses" base = "BaseTfsResponse" file = "Responses\\ShelvesetResponse.cs" +[[properties]] +parent = "ShelvesetResponse" +name = "Settings" +sig = "static JsonSerializerSettings Settings { get; }" +returns = "JsonSerializerSettings" +file = "Responses\\ShelvesetResponse.cs" +static = true + +[[properties]] +parent = "ShelvesetResponse" +name = "Value" +sig = "ShelvesetContent[] Value { get; set; }" +returns = "ShelvesetContent[]" +file = "Responses\\ShelvesetResponse.cs" + [[classes]] name = "TfsService" ns = "FEx.AzureDevOpsx.Services" base = "ThreadingAwareViewModel" file = "Services\\TFSService.cs" +[[properties]] +parent = "TfsService" +name = "ImagesCacheDirPath" +sig = "static string ImagesCacheDirPath { get; set; }" +returns = "string" +file = "Services\\TFSService.cs" +static = true + +[[properties]] +parent = "TfsService" +name = "EnvironmentSet" +sig = "EventHandler EnvironmentSet { get; set; }" +returns = "EventHandler" +file = "Services\\TFSService.cs" + +[[properties]] +parent = "TfsService" +name = "TfsUriChange" +sig = "EventHandler TfsUriChange { get; set; }" +returns = "EventHandler" +file = "Services\\TFSService.cs" + +[[properties]] +parent = "TfsService" +name = "TfsEnvironments" +sig = "ConcurrentObservableList TfsEnvironments { get; }" +returns = "ConcurrentObservableList" +file = "Services\\TFSService.cs" + +[[properties]] +parent = "TfsService" +name = "SelectedEnvironment" +sig = "TfsEnvironment SelectedEnvironment { get; set; }" +returns = "TfsEnvironment" +file = "Services\\TFSService.cs" + +[[methods]] +parent = "TfsService" +name = "SetEnvironments" +sig = "static void SetEnvironments(IDictionary environments, IProgressAggregator mainViewModel)" +returns = "void" +file = "Services\\TFSService.cs" +static = true + +[[methods]] +parent = "TfsService" +name = "GetEnvironmentId" +sig = "static string GetEnvironmentId(string requestUrl, ICredentials credentials)" +returns = "string" +file = "Services\\TFSService.cs" +static = true + +[[methods]] +parent = "TfsService" +name = "RunProcAsync" +sig = "Task RunProcAsync(string requestUrl, string environmentId, IDictionary args = null, IList omitCodes = null, JsonSerializerSettings settings = null, RequestMethod method = RequestMethod.GET) where TResponse : BaseTfsResponse, new()" +returns = "Task" +file = "Services\\TFSService.cs" + +[[methods]] +parent = "TfsService" +name = "RunRawAsync" +sig = "Task RunRawAsync(string requestUrl, string environmentId, IDictionary args = null, IList omitCodes = null, RequestMethod method = RequestMethod.GET)" +returns = "Task" +file = "Services\\TFSService.cs" + +[[properties]] +parent = "TfsService" +name = "Instance" +sig = "static TfsService Instance { get; }" +returns = "TfsService" +file = "Services\\TFSService.cs" +static = true + diff --git a/.api-surface/FEx/AzureStorage.toml b/.api-surface/FEx/AzureStorage.toml index 2b42799d..c8d9635a 100644 --- a/.api-surface/FEx/AzureStorage.toml +++ b/.api-surface/FEx/AzureStorage.toml @@ -7,12 +7,165 @@ name = "AzureStorageConfiguration" ns = "FEx.AzureStorage" file = "AzureStorageConfiguration.cs" +[[properties]] +parent = "AzureStorageConfiguration" +name = "ConnectionString" +sig = "string ConnectionString { get; set; }" +returns = "string" +file = "AzureStorageConfiguration.cs" + [[classes]] name = "AzureStorageService" ns = "FEx.AzureStorage" base = "IAzureStorageService" file = "AzureStorageService.cs" +[[properties]] +parent = "AzureStorageService" +name = "ProgressReporter" +sig = "Progress ProgressReporter { get; }" +returns = "Progress" +file = "AzureStorageService.cs" + +[[properties]] +parent = "AzureStorageService" +name = "ConnStr" +sig = "string ConnStr { get; }" +returns = "string" +file = "AzureStorageService.cs" + +[[properties]] +parent = "AzureStorageService" +name = "ProgressStates" +sig = "ConcurrentDictionary ProgressStates { get; }" +returns = "ConcurrentDictionary" +file = "AzureStorageService.cs" + +[[properties]] +parent = "AzureStorageService" +name = "Log" +sig = "ILogger Log { get; }" +returns = "ILogger" +file = "AzureStorageService.cs" + +[[ctors]] +parent = "AzureStorageService" +sig = "AzureStorageService(ILogger logger)" +file = "AzureStorageService.cs" + +[[methods]] +parent = "AzureStorageService" +name = "Configure" +sig = "void Configure(string connStr, int parallelOperationsPerProcessorCount)" +returns = "void" +file = "AzureStorageService.cs" + +[[methods]] +parent = "AzureStorageService" +name = "ProcessBlobAsync" +sig = "Task<(string fileName, FileInfo localPath)> ProcessBlobAsync( string containerName, string downloadDir, string path)" +returns = "Task<(string fileName, FileInfo localPath)>" +file = "AzureStorageService.cs" + +[[methods]] +parent = "AzureStorageService" +name = "GetCloudBlobContainer" +sig = "CloudBlobContainer GetCloudBlobContainer(string containerName)" +returns = "CloudBlobContainer" +file = "AzureStorageService.cs" + +[[methods]] +parent = "AzureStorageService" +name = "DownloadLatestBlobsAsync" +sig = "Task DownloadLatestBlobsAsync(string downloadDir, string containerName, bool deleteOldFiles, string deleteFilesMask, bool noDownload, params string[] paths)" +returns = "Task" +file = "AzureStorageService.cs" + +[[methods]] +parent = "AzureStorageService" +name = "UploadStreamAsync" +sig = "Task<(string file, CloudBlockBlob blob)> UploadStreamAsync( string path, bool overwrite, string fileName, Stream stream, string containerName, CloudBlobContainer container)" +returns = "Task<(string file, CloudBlockBlob blob)>" +file = "AzureStorageService.cs" + +[[methods]] +parent = "AzureStorageService" +name = "GetBlobAsync" +sig = "Task GetBlobAsync(string path, CloudBlobContainer container, string containerName, CancellationToken cancellationToken)" +returns = "Task" +file = "AzureStorageService.cs" + +[[methods]] +parent = "AzureStorageService" +name = "GetCloudBlockBlobsInfoAsync" +sig = "Task> GetCloudBlockBlobsInfoAsync( string containerName, string path, bool useFlatBlobListing)" +returns = "Task>" +file = "AzureStorageService.cs" + +[[methods]] +parent = "AzureStorageService" +name = "GetCloudBlockBlobsAsync" +sig = "Task> GetCloudBlockBlobsAsync(string containerName, string path, bool useFlatBlobListing)" +returns = "Task>" +file = "AzureStorageService.cs" + +[[methods]] +parent = "AzureStorageService" +name = "GetBlobsAsync" +sig = "Task> GetBlobsAsync(string containerName, string path, bool useFlatBlobListing) where T : CloudBlob" +returns = "Task>" +file = "AzureStorageService.cs" + +[[methods]] +parent = "AzureStorageService" +name = "ExistsAsync" +sig = "Task ExistsAsync(string containerName, string path, string fileName, bool primaryOnly, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)" +returns = "Task" +file = "AzureStorageService.cs" + +[[methods]] +parent = "AzureStorageService" +name = "ExistsAsync" +sig = "Task ExistsAsync(CloudBlockBlob blob, bool primaryOnly, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)" +returns = "Task" +file = "AzureStorageService.cs" + +[[methods]] +parent = "AzureStorageService" +name = "CopyBlobAsync" +sig = "Task<(CloudBlockBlob blob, bool isSuccess)> CopyBlobAsync( string containerName, string srcBlob, string destBlob, bool overwrite, Func blobAction)" +returns = "Task<(CloudBlockBlob blob, bool isSuccess)>" +file = "AzureStorageService.cs" + +[[methods]] +parent = "AzureStorageService" +name = "UploadFilesAsync" +sig = "Task> UploadFilesAsync( string containerName, string path, bool overwrite, bool oneByOne, params FileInfo[] files)" +returns = "Task>" +file = "AzureStorageService.cs" + +[[methods]] +parent = "AzureStorageService" +name = "UploadFileAsync" +sig = "Task<(FileInfo file, CloudBlockBlobInfo blob)> UploadFileAsync( string path, bool overwrite, FileInfo file, string containerName, CloudBlobContainer container, CancellationToken cancellationToken)" +returns = "Task<(FileInfo file, CloudBlockBlobInfo blob)>" +file = "AzureStorageService.cs" + +[[methods]] +parent = "AzureStorageService" +name = "DeleteBlobAsync" +sig = "Task DeleteBlobAsync(CloudBlockBlob blob, DeleteSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)" +returns = "Task" +file = "AzureStorageService.cs" + +[[methods]] +parent = "AzureStorageService" +name = "EnsureDefaultServiceVersion" +sig = "static void EnsureDefaultServiceVersion(string connectionString)" +returns = "void" +file = "AzureStorageService.cs" +static = true + [[classes]] name = "AzureStorageWorker" ns = "FEx.AzureStorage" @@ -23,16 +176,340 @@ name = "CloudBlockBlobInfo" ns = "FEx.AzureStorage" file = "CloudBlockBlobInfo.cs" +[[properties]] +parent = "CloudBlockBlobInfo" +name = "Blob" +sig = "CloudBlockBlob Blob { get; }" +returns = "CloudBlockBlob" +file = "CloudBlockBlobInfo.cs" + +[[properties]] +parent = "CloudBlockBlobInfo" +name = "Uri" +sig = "Uri Uri { get; set; }" +returns = "Uri" +file = "CloudBlockBlobInfo.cs" + +[[properties]] +parent = "CloudBlockBlobInfo" +name = "Checksum" +sig = "string Checksum { get; set; }" +returns = "string" +file = "CloudBlockBlobInfo.cs" + +[[properties]] +parent = "CloudBlockBlobInfo" +name = "Name" +sig = "string Name { get; set; }" +returns = "string" +file = "CloudBlockBlobInfo.cs" + +[[properties]] +parent = "CloudBlockBlobInfo" +name = "Extension" +sig = "string Extension { get; set; }" +returns = "string" +file = "CloudBlockBlobInfo.cs" + +[[properties]] +parent = "CloudBlockBlobInfo" +name = "Exists" +sig = "bool Exists { get; set; }" +returns = "bool" +file = "CloudBlockBlobInfo.cs" + +[[properties]] +parent = "CloudBlockBlobInfo" +name = "Metadata" +sig = "IDictionary Metadata { get; }" +returns = "IDictionary" +file = "CloudBlockBlobInfo.cs" + +[[properties]] +parent = "CloudBlockBlobInfo" +name = "Size" +sig = "long Size { get; }" +returns = "long" +file = "CloudBlockBlobInfo.cs" + +[[properties]] +parent = "CloudBlockBlobInfo" +name = "ContentType" +sig = "string ContentType { get; set; }" +returns = "string" +file = "CloudBlockBlobInfo.cs" + +[[ctors]] +parent = "CloudBlockBlobInfo" +sig = "CloudBlockBlobInfo(CloudBlockBlob blob)" +file = "CloudBlockBlobInfo.cs" + +[[ctors]] +parent = "CloudBlockBlobInfo" +sig = "CloudBlockBlobInfo(CloudBlockBlob blob, bool? exists)" +file = "CloudBlockBlobInfo.cs" + +[[methods]] +parent = "CloudBlockBlobInfo" +name = "GetMetadata" +sig = "string GetMetadata(string key)" +returns = "string" +file = "CloudBlockBlobInfo.cs" + +[[methods]] +parent = "CloudBlockBlobInfo" +name = "EnsureExistsAsync" +sig = "Task EnsureExistsAsync()" +returns = "Task" +file = "CloudBlockBlobInfo.cs" + +[[methods]] +parent = "CloudBlockBlobInfo" +name = "EnsureExistsAsync" +sig = "Task EnsureExistsAsync(bool primaryOnly, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)" +returns = "Task" +file = "CloudBlockBlobInfo.cs" + +[[methods]] +parent = "CloudBlockBlobInfo" +name = "FetchAttributesAsync" +sig = "Task FetchAttributesAsync()" +returns = "Task" +summary = "Fetches the attributes asynchronous." +file = "CloudBlockBlobInfo.cs" + +[[methods]] +parent = "CloudBlockBlobInfo" +name = "FetchAttributesAsync" +sig = "Task FetchAttributesAsync(AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)" +returns = "Task" +summary = "Fetches the attributes asynchronous." +file = "CloudBlockBlobInfo.cs" + +[[methods]] +parent = "CloudBlockBlobInfo" +name = "EnsureMetadata" +sig = "void EnsureMetadata()" +returns = "void" +file = "CloudBlockBlobInfo.cs" + [[interfaces]] name = "IAzureStorageService" ns = "FEx.AzureStorage" file = "IAzureStorageService.cs" +[[methods]] +parent = "IAzureStorageService" +name = "Configure" +sig = "void Configure(string connStr, int parallelOpsMultiplier)" +returns = "void" +file = "IAzureStorageService.cs" + +[[methods]] +parent = "IAzureStorageService" +name = "CopyBlobAsync" +sig = "Task<(CloudBlockBlob blob, bool isSuccess)> CopyBlobAsync(string containerName, string srcBlob, string destBlob, bool overwrite, Func blobAction)" +returns = "Task<(CloudBlockBlob blob, bool isSuccess)>" +file = "IAzureStorageService.cs" + +[[methods]] +parent = "IAzureStorageService" +name = "DeleteBlobAsync" +sig = "Task DeleteBlobAsync(CloudBlockBlob blob, DeleteSnapshotsOption deleteSnapshotsOption, AccessCondition accessCondition, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)" +returns = "Task" +file = "IAzureStorageService.cs" + +[[methods]] +parent = "IAzureStorageService" +name = "DownloadLatestBlobsAsync" +sig = "Task DownloadLatestBlobsAsync(string downloadDir, string containerName, bool deleteOldFiles, string deleteFilesMask, bool noDownload, params string[] paths)" +returns = "Task" +file = "IAzureStorageService.cs" + +[[methods]] +parent = "IAzureStorageService" +name = "ExistsAsync" +sig = "Task ExistsAsync(CloudBlockBlob blob, bool primaryOnly, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)" +returns = "Task" +file = "IAzureStorageService.cs" + +[[methods]] +parent = "IAzureStorageService" +name = "ExistsAsync" +sig = "Task ExistsAsync(string containerName, string path, string fileName, bool primaryOnly, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)" +returns = "Task" +file = "IAzureStorageService.cs" + +[[methods]] +parent = "IAzureStorageService" +name = "GetBlobAsync" +sig = "Task GetBlobAsync(string path, CloudBlobContainer container, string containerName, CancellationToken cancellationToken)" +returns = "Task" +file = "IAzureStorageService.cs" + +[[methods]] +parent = "IAzureStorageService" +name = "GetBlobsAsync" +sig = "Task> GetBlobsAsync(string containerName, string path, bool useFlatBlobListing) where T : CloudBlob" +returns = "Task>" +file = "IAzureStorageService.cs" + +[[methods]] +parent = "IAzureStorageService" +name = "GetCloudBlobContainer" +sig = "CloudBlobContainer GetCloudBlobContainer(string containerName)" +returns = "CloudBlobContainer" +file = "IAzureStorageService.cs" + +[[methods]] +parent = "IAzureStorageService" +name = "GetCloudBlockBlobsAsync" +sig = "Task> GetCloudBlockBlobsAsync(string containerName, string path, bool useFlatBlobListing)" +returns = "Task>" +file = "IAzureStorageService.cs" + +[[methods]] +parent = "IAzureStorageService" +name = "GetCloudBlockBlobsInfoAsync" +sig = "Task> GetCloudBlockBlobsInfoAsync(string containerName, string path, bool useFlatBlobListing)" +returns = "Task>" +file = "IAzureStorageService.cs" + +[[methods]] +parent = "IAzureStorageService" +name = "ProcessBlobAsync" +sig = "Task<(string fileName, FileInfo localPath)> ProcessBlobAsync(string containerName, string downloadDir, string path)" +returns = "Task<(string fileName, FileInfo localPath)>" +file = "IAzureStorageService.cs" + +[[methods]] +parent = "IAzureStorageService" +name = "UploadFileAsync" +sig = "Task<(FileInfo file, CloudBlockBlobInfo blob)> UploadFileAsync(string path, bool overwrite, FileInfo file, string containerName, CloudBlobContainer container, CancellationToken cancellationToken)" +returns = "Task<(FileInfo file, CloudBlockBlobInfo blob)>" +file = "IAzureStorageService.cs" + +[[methods]] +parent = "IAzureStorageService" +name = "UploadFilesAsync" +sig = "Task> UploadFilesAsync(string containerName, string path, bool overwrite, bool oneByOne, params FileInfo[] files)" +returns = "Task>" +file = "IAzureStorageService.cs" + +[[methods]] +parent = "IAzureStorageService" +name = "UploadStreamAsync" +sig = "Task<(string file, CloudBlockBlob blob)> UploadStreamAsync(string path, bool overwrite, string fileName, Stream stream, string containerName, CloudBlobContainer container)" +returns = "Task<(string file, CloudBlockBlob blob)>" +file = "IAzureStorageService.cs" + [[classes]] name = "ProgressState" ns = "FEx.AzureStorage" file = "ProgressState.cs" +[[properties]] +parent = "ProgressState" +name = "LoggedProgress" +sig = "long LoggedProgress { get; set; }" +returns = "long" +file = "ProgressState.cs" + +[[properties]] +parent = "ProgressState" +name = "LoggedPercentage" +sig = "double LoggedPercentage { get; set; }" +returns = "double" +file = "ProgressState.cs" + +[[properties]] +parent = "ProgressState" +name = "TotalSize" +sig = "double TotalSize { get; }" +returns = "double" +file = "ProgressState.cs" + +[[properties]] +parent = "ProgressState" +name = "Name" +sig = "string Name { get; }" +returns = "string" +file = "ProgressState.cs" + +[[properties]] +parent = "ProgressState" +name = "OperationString" +sig = "object OperationString { get; }" +returns = "object" +file = "ProgressState.cs" + +[[properties]] +parent = "ProgressState" +name = "ElapsedTime" +sig = "string ElapsedTime { get; }" +returns = "string" +file = "ProgressState.cs" + +[[properties]] +parent = "ProgressState" +name = "Sw" +sig = "Stopwatch Sw { get; }" +returns = "Stopwatch" +file = "ProgressState.cs" + +[[ctors]] +parent = "ProgressState" +sig = "ProgressState(IProgress progress, StorageOperation operation)" +file = "ProgressState.cs" + +[[ctors]] +parent = "ProgressState" +sig = "ProgressState(IProgress progress, StorageOperation operation, string name, double? totalSize)" +file = "ProgressState.cs" + +[[methods]] +parent = "ProgressState" +name = "GetProgress" +sig = "static string GetProgress(double prg)" +returns = "string" +file = "ProgressState.cs" +static = true + +[[methods]] +parent = "ProgressState" +name = "Reset" +sig = "void Reset()" +returns = "void" +file = "ProgressState.cs" + +[[methods]] +parent = "ProgressState" +name = "Reset" +sig = "void Reset(string name, double? totalSize, StorageOperation? operation)" +returns = "void" +file = "ProgressState.cs" + +[[methods]] +parent = "ProgressState" +name = "LogProgress" +sig = "void LogProgress(TransferStatus progress)" +returns = "void" +file = "ProgressState.cs" + +[[methods]] +parent = "ProgressState" +name = "Restart" +sig = "void Restart()" +returns = "void" +file = "ProgressState.cs" + +[[methods]] +parent = "ProgressState" +name = "Stop" +sig = "void Stop()" +returns = "void" +file = "ProgressState.cs" + [[enums]] name = "StorageOperation" ns = "FEx.AzureStorage" @@ -46,75 +523,80 @@ static = true [[extensions]] name = "Configure" -sig = "void Configure(this IAzureStorageService service, string connStr)" returns = "void" +sig = "void Configure(this IAzureStorageService service, string connStr)" file = "Extensions\\AzureStorageServiceExtensions.cs" [[extensions]] name = "CopyBlobAsync" -sig = "Task<(CloudBlockBlob blob, bool isSuccess)> CopyBlobAsync( - this IAzureStorageService service, - string containerName, - string srcBlob, - string destBlob)" returns = "Task<(CloudBlockBlob blob, bool isSuccess)>" +sig = "Task<(CloudBlockBlob blob, bool isSuccess)> CopyBlobAsync( this IAzureStorageService service, string containerName, string srcBlob, string destBlob)" file = "Extensions\\AzureStorageServiceExtensions.cs" [[extensions]] name = "DeleteBlobAsync" -sig = "Task DeleteBlobAsync(this IAzureStorageService service, CloudBlockBlob blob)" returns = "Task" +sig = "Task DeleteBlobAsync(this IAzureStorageService service, CloudBlockBlob blob)" file = "Extensions\\AzureStorageServiceExtensions.cs" [[extensions]] name = "DownloadLatestBlobsAsync" -sig = "Task DownloadLatestBlobsAsync(this IAzureStorageService service, - string downloadDir, - string containerName, - params string[] paths)" returns = "Task" +sig = "Task DownloadLatestBlobsAsync(this IAzureStorageService service, string downloadDir, string containerName, params string[] paths)" file = "Extensions\\AzureStorageServiceExtensions.cs" [[extensions]] name = "ExistsAsync" -sig = "Task ExistsAsync(this IAzureStorageService service, CloudBlockBlob blob)" returns = "Task" +sig = "Task ExistsAsync(this IAzureStorageService service, CloudBlockBlob blob)" file = "Extensions\\AzureStorageServiceExtensions.cs" [[extensions]] name = "ExistsAsync" -sig = "Task ExistsAsync(this IAzureStorageService service, - string containerName, - string path, - string fileName)" returns = "Task" +sig = "Task ExistsAsync(this IAzureStorageService service, string containerName, string path, string fileName)" file = "Extensions\\AzureStorageServiceExtensions.cs" [[extensions]] name = "GetBlobAsync" -sig = "Task GetBlobAsync(this IAzureStorageService service, string path)" returns = "Task" +sig = "Task GetBlobAsync(this IAzureStorageService service, string path)" +file = "Extensions\\AzureStorageServiceExtensions.cs" + +[[extensions]] +name = "GetBlobsAsync" +returns = "Task>" +sig = "Task> GetBlobsAsync(this IAzureStorageService service, string containerName, string path)" +file = "Extensions\\AzureStorageServiceExtensions.cs" + +[[extensions]] +name = "GetCloudBlockBlobsAsync" +returns = "Task>" +sig = "Task> GetCloudBlockBlobsAsync(this IAzureStorageService service, string containerName, string path)" +file = "Extensions\\AzureStorageServiceExtensions.cs" + +[[extensions]] +name = "GetCloudBlockBlobsInfoAsync" +returns = "Task>" +sig = "Task> GetCloudBlockBlobsInfoAsync( this IAzureStorageService service, string containerName, string path)" file = "Extensions\\AzureStorageServiceExtensions.cs" [[extensions]] name = "UploadFileAsync" -sig = "Task<(FileInfo file, CloudBlockBlobInfo blob)> UploadFileAsync( - this IAzureStorageService service, - string path, - bool overwrite, - FileInfo file)" returns = "Task<(FileInfo file, CloudBlockBlobInfo blob)>" +sig = "Task<(FileInfo file, CloudBlockBlobInfo blob)> UploadFileAsync( this IAzureStorageService service, string path, bool overwrite, FileInfo file)" +file = "Extensions\\AzureStorageServiceExtensions.cs" + +[[extensions]] +name = "UploadFilesAsync" +returns = "Task>" +sig = "Task> UploadFilesAsync( this IAzureStorageService service, string containerName, string path, params FileInfo[] files)" file = "Extensions\\AzureStorageServiceExtensions.cs" [[extensions]] name = "UploadStreamAsync" -sig = "Task<(string file, CloudBlockBlob blob)> UploadStreamAsync( - this IAzureStorageService service, - string path, - bool overwrite, - string fileName, - Stream stream)" returns = "Task<(string file, CloudBlockBlob blob)>" +sig = "Task<(string file, CloudBlockBlob blob)> UploadStreamAsync( this IAzureStorageService service, string path, bool overwrite, string fileName, Stream stream)" file = "Extensions\\AzureStorageServiceExtensions.cs" [[classes]] @@ -125,25 +607,55 @@ static = true [[extensions]] name = "GetBlobChecksum" -sig = "string GetBlobChecksum(this CloudBlockBlob blob)" returns = "string" +sig = "string GetBlobChecksum(this CloudBlockBlob blob)" file = "Extensions\\BlobExtensions.cs" [[extensions]] name = "GetBlobUri" -sig = "Uri GetBlobUri(this CloudBlockBlob blob)" returns = "Uri" +sig = "Uri GetBlobUri(this CloudBlockBlob blob)" file = "Extensions\\BlobExtensions.cs" [[extensions]] name = "GetBlobChecksum" -sig = "string GetBlobChecksum(this BlobItem blob)" returns = "string" +sig = "string GetBlobChecksum(this BlobItem blob)" file = "Extensions\\BlobExtensions.cs" [[extensions]] name = "GetBlobUri" -sig = "Uri GetBlobUri(this BlobItem blob, BlobContainerClient blobContainerClient)" returns = "Uri" +sig = "Uri GetBlobUri(this BlobItem blob, BlobContainerClient blobContainerClient)" +file = "Extensions\\BlobExtensions.cs" + +[[extensions]] +name = "ListBlobsAsync" +returns = "Task>" +sig = "Task> ListBlobsAsync(this CloudBlobDirectory directory, CancellationToken cancellationToken)" +file = "Extensions\\BlobExtensions.cs" + +[[extensions]] +name = "ListContainersAsync" +returns = "Task>" +sig = "Task> ListContainersAsync( this CloudBlobClient client, CancellationToken cancellationToken)" +file = "Extensions\\BlobExtensions.cs" + +[[extensions]] +name = "ListBlobsAsync" +returns = "Task, StackError>>" +sig = "Task, StackError>> ListBlobsAsync( this CloudBlobContainer client, string prefix, CancellationToken cancellationToken)" +file = "Extensions\\BlobExtensions.cs" + +[[extensions]] +name = "ListBlobsAsync" +returns = "Task, StackError>>" +sig = "Task, StackError>> ListBlobsAsync( this CloudBlobContainer client, string prefix, bool useFlatBlobListing, BlobListingDetails blobListingDetails, BlobRequestOptions options, OperationContext operationContext, CancellationToken cancellationToken)" +file = "Extensions\\BlobExtensions.cs" + +[[extensions]] +name = "EnsureCorrectContentTypeAsync" +returns = "Task" +sig = "Task EnsureCorrectContentTypeAsync(this CloudBlockBlobInfo arg)" file = "Extensions\\BlobExtensions.cs" diff --git a/.api-surface/FEx/Building.toml b/.api-surface/FEx/Building.toml index 1cad8138..63d26648 100644 --- a/.api-surface/FEx/Building.toml +++ b/.api-surface/FEx/Building.toml @@ -10,14 +10,20 @@ static = true [[extensions]] name = "LogError" -sig = "void LogError(this Exception ex)" returns = "void" +sig = "void LogError(this ILogger logger, T exception)" +file = "BuildExtensions.cs" + +[[extensions]] +name = "LogError" +returns = "void" +sig = "void LogError(this Exception ex)" file = "BuildExtensions.cs" [[extensions]] name = "GetLogger" -sig = "ILogger GetLogger(this object sender)" returns = "ILogger" +sig = "ILogger GetLogger(this object sender)" file = "BuildExtensions.cs" [[classes]] @@ -32,36 +38,462 @@ ns = "FEx.Building" base = "TypeConverter" file = "Configuration.cs" +[[methods]] +parent = "ConfigurationTypeConverter" +name = "CanConvertFrom" +sig = "bool CanConvertFrom(ITypeDescriptorContext? context, Type sourceType)" +returns = "bool" +file = "Configuration.cs" + +[[methods]] +parent = "ConfigurationTypeConverter" +name = "ConvertFrom" +sig = "object? ConvertFrom(ITypeDescriptorContext? context, CultureInfo? culture, object value)" +returns = "object?" +file = "Configuration.cs" + [[classes]] name = "FExBuild" ns = "FEx.Building" base = "NukeBuild, ICompileTarget" file = "FExBuild.cs" +[[properties]] +parent = "FExBuild" +name = "Logo" +sig = "static IEnumerable Logo { get; }" +returns = "IEnumerable" +file = "FExBuild.cs" +static = true + +[[properties]] +parent = "FExBuild" +name = "Configuration" +sig = "Configuration Configuration { get; }" +returns = "Configuration" +file = "FExBuild.cs" + +[[properties]] +parent = "FExBuild" +name = "Solution" +sig = "Solution Solution { get; }" +returns = "Solution" +file = "FExBuild.cs" + +[[methods]] +parent = "FExBuild" +name = "GetBuildSettings" +sig = "DotNetBuildSettings GetBuildSettings( DotNetBuildSettings settings, AbsolutePath solution, bool noRestore = true, DotNetVerbosity? verbosity = null)" +returns = "DotNetBuildSettings" +file = "FExBuild.cs" + +[[methods]] +parent = "FExBuild" +name = "GetRestoreSettings" +sig = "DotNetRestoreSettings GetRestoreSettings(DotNetRestoreSettings settings, AbsolutePath solution, Configuration? configuration = null)" +returns = "DotNetRestoreSettings" +file = "FExBuild.cs" + +[[methods]] +parent = "FExBuild" +name = "GetBuildPlan" +sig = "string GetBuildPlan()" +returns = "string" +file = "FExBuild.cs" + +[[methods]] +parent = "FExBuild" +name = "PrintBanner" +sig = "static void PrintBanner()" +returns = "void" +file = "FExBuild.cs" +static = true + +[[methods]] +parent = "FExBuild" +name = "DisableTelemetry" +sig = "static void DisableTelemetry()" +returns = "void" +file = "FExBuild.cs" +static = true + +[[methods]] +parent = "FExBuild" +name = "Bootstrap" +sig = "static void Bootstrap()" +returns = "void" +file = "FExBuild.cs" +static = true + +[[methods]] +parent = "FExBuild" +name = "LogBuildInfo" +sig = "void LogBuildInfo()" +returns = "void" +file = "FExBuild.cs" + [[interfaces]] name = "ICompileTarget" ns = "FEx.Building" +base = "INukeBuild" +file = "ICompileTarget.cs" + +[[properties]] +parent = "ICompileTarget" +name = "Solution" +sig = "Solution Solution { get; }" +returns = "Solution" +file = "ICompileTarget.cs" + +[[properties]] +parent = "ICompileTarget" +name = "Configuration" +sig = "Configuration Configuration { get; }" +returns = "Configuration" file = "ICompileTarget.cs" +[[properties]] +parent = "ICompileTarget" +name = "Restore" +sig = "Target Restore { get; }" +returns = "Target" +file = "ICompileTarget.cs" + +[[properties]] +parent = "ICompileTarget" +name = "Compile" +sig = "Target Compile { get; }" +returns = "Target" +file = "ICompileTarget.cs" + +[[interfaces]] +name = "IGitVersionComponent" +ns = "FEx.Building" +base = "INukeBuild" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "IGitVersionComponent" +name = "VersionInfo" +sig = "GitVersionInfo? VersionInfo { get; }" +returns = "GitVersionInfo?" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "IGitVersionComponent" +name = "SemVer" +sig = "string SemVer { get; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "IGitVersionComponent" +name = "NuGetVersion" +sig = "string NuGetVersion { get; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "IGitVersionComponent" +name = "InformationalVersion" +sig = "string InformationalVersion { get; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[methods]] +parent = "IGitVersionComponent" +name = "ResolveGitVersion" +sig = "GitVersionInfo ResolveGitVersion()" +returns = "GitVersionInfo" +file = "IGitVersionComponent.cs" + +[[classes]] +name = "GitVersionInfo" +ns = "FEx.Building" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "Major" +sig = "int Major { get; init; }" +returns = "int" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "Minor" +sig = "int Minor { get; init; }" +returns = "int" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "Patch" +sig = "int Patch { get; init; }" +returns = "int" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "PreReleaseTag" +sig = "string PreReleaseTag { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "PreReleaseTagWithDash" +sig = "string PreReleaseTagWithDash { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "PreReleaseLabel" +sig = "string PreReleaseLabel { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "PreReleaseLabelWithDash" +sig = "string PreReleaseLabelWithDash { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "PreReleaseNumber" +sig = "int? PreReleaseNumber { get; init; }" +returns = "int?" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "WeightedPreReleaseNumber" +sig = "int? WeightedPreReleaseNumber { get; init; }" +returns = "int?" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "BuildMetaData" +sig = "string BuildMetaData { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "FullBuildMetaData" +sig = "string FullBuildMetaData { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "MajorMinorPatch" +sig = "string MajorMinorPatch { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "SemVer" +sig = "string SemVer { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "AssemblySemVer" +sig = "string AssemblySemVer { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "AssemblySemFileVer" +sig = "string AssemblySemFileVer { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "FullSemVer" +sig = "string FullSemVer { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "InformationalVersion" +sig = "string InformationalVersion { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "BranchName" +sig = "string BranchName { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "EscapedBranchName" +sig = "string EscapedBranchName { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "Sha" +sig = "string Sha { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "ShortSha" +sig = "string ShortSha { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "NuGetVersionV2" +sig = "string NuGetVersionV2 { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "NuGetVersion" +sig = "string NuGetVersion { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "NuGetPreReleaseTag" +sig = "string NuGetPreReleaseTag { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "NuGetPreReleaseTagV2" +sig = "string NuGetPreReleaseTagV2 { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "VersionSourceSha" +sig = "string VersionSourceSha { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "CommitsSinceVersionSource" +sig = "int CommitsSinceVersionSource { get; init; }" +returns = "int" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "CommitDate" +sig = "string CommitDate { get; init; }" +returns = "string" +file = "IGitVersionComponent.cs" + +[[properties]] +parent = "GitVersionInfo" +name = "UncommittedChanges" +sig = "int UncommittedChanges { get; init; }" +returns = "int" +file = "IGitVersionComponent.cs" + +[[methods]] +parent = "GitVersionInfo" +name = "WithPatch" +sig = "GitVersionInfo WithPatch(int newPatch)" +returns = "GitVersionInfo" +file = "IGitVersionComponent.cs" + [[classes]] name = "LenientStringConverter" ns = "FEx.Building" base = "JsonConverter" file = "IGitVersionComponent.cs" -[[interfaces]] -name = "IGitVersionComponent" -ns = "FEx.Building" +[[methods]] +parent = "LenientStringConverter" +name = "Read" +sig = "string Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)" +returns = "string" +file = "IGitVersionComponent.cs" + +[[methods]] +parent = "LenientStringConverter" +name = "Write" +sig = "void Write(Utf8JsonWriter writer, string value, JsonSerializerOptions options)" +returns = "void" file = "IGitVersionComponent.cs" [[interfaces]] name = "INuGetPublishTarget" ns = "FEx.Building" +base = "IPackTarget" +file = "INuGetPublishTarget.cs" + +[[properties]] +parent = "INuGetPublishTarget" +name = "NuGetSource" +sig = "string NuGetSource { get; }" +returns = "string" +file = "INuGetPublishTarget.cs" + +[[properties]] +parent = "INuGetPublishTarget" +name = "NuGetApiKey" +sig = "string? NuGetApiKey { get; }" +returns = "string?" +file = "INuGetPublishTarget.cs" + +[[properties]] +parent = "INuGetPublishTarget" +name = "Publish" +sig = "Target Publish { get; }" +returns = "Target" file = "INuGetPublishTarget.cs" [[interfaces]] name = "IPackTarget" ns = "FEx.Building" +base = "ICompileTarget, IGitVersionComponent" +file = "IPackTarget.cs" + +[[properties]] +parent = "IPackTarget" +name = "PackProject" +sig = "string? PackProject { get; }" +returns = "string?" +file = "IPackTarget.cs" + +[[properties]] +parent = "IPackTarget" +name = "PackagesDirectory" +sig = "AbsolutePath PackagesDirectory { get; }" +returns = "AbsolutePath" +file = "IPackTarget.cs" + +[[properties]] +parent = "IPackTarget" +name = "Pack" +sig = "Target Pack { get; }" +returns = "Target" file = "IPackTarget.cs" [[interfaces]] @@ -69,14 +501,111 @@ name = "IRepositoryInfo" ns = "FEx.Building" file = "IRepositoryInfo.cs" +[[properties]] +parent = "IRepositoryInfo" +name = "CommitHash" +sig = "string CommitHash { get; }" +returns = "string" +file = "IRepositoryInfo.cs" + +[[properties]] +parent = "IRepositoryInfo" +name = "BranchName" +sig = "string BranchName { get; }" +returns = "string" +file = "IRepositoryInfo.cs" + +[[properties]] +parent = "IRepositoryInfo" +name = "Type" +sig = "string Type { get; }" +returns = "string" +file = "IRepositoryInfo.cs" + +[[properties]] +parent = "IRepositoryInfo" +name = "Url" +sig = "string Url { get; }" +returns = "string" +file = "IRepositoryInfo.cs" + +[[methods]] +parent = "IRepositoryInfo" +name = "UpdateRepositoryInfo" +sig = "DotNetPackSettings UpdateRepositoryInfo(DotNetPackSettings settings)" +returns = "DotNetPackSettings" +file = "IRepositoryInfo.cs" + [[interfaces]] name = "ITagTarget" ns = "FEx.Building" +base = "INuGetPublishTarget" +file = "ITagTarget.cs" + +[[properties]] +parent = "ITagTarget" +name = "TagPrefix" +sig = "string TagPrefix { get; }" +returns = "string" +file = "ITagTarget.cs" + +[[properties]] +parent = "ITagTarget" +name = "Tag" +sig = "Target Tag { get; }" +returns = "Target" +file = "ITagTarget.cs" + +[[methods]] +parent = "ITagTarget" +name = "ResolveCiRemote" +sig = "static (string? Branch, string PushUrl)? ResolveCiRemote()" +returns = "(string? Branch, string PushUrl)?" +file = "ITagTarget.cs" +static = true + +[[methods]] +parent = "ITagTarget" +name = "IsReleaseBranch" +sig = "static bool IsReleaseBranch(string? branch)" +returns = "bool" +file = "ITagTarget.cs" +static = true + +[[methods]] +parent = "ITagTarget" +name = "TagExists" +sig = "static bool TagExists(string tag)" +returns = "bool" file = "ITagTarget.cs" +static = true + +[[methods]] +parent = "ITagTarget" +name = "RunGit" +sig = "static void RunGit(string arguments)" +returns = "void" +file = "ITagTarget.cs" +static = true [[interfaces]] name = "ITestTarget" ns = "FEx.Building" +base = "ICompileTarget" +file = "ITestTarget.cs" + +[[properties]] +parent = "ITestTarget" +name = "TestResultsDirectory" +sig = "AbsolutePath TestResultsDirectory { get; }" +returns = "AbsolutePath" +file = "ITestTarget.cs" + +[[properties]] +parent = "ITestTarget" +name = "Test" +sig = "Target Test { get; }" +returns = "Target" file = "ITestTarget.cs" [[classes]] @@ -87,9 +616,8 @@ static = true [[extensions]] name = "UpdateRepositoryInfo" -sig = "DotNetPackSettings UpdateRepositoryInfo(this DotNetPackSettings toolSettings, - IRepositoryInfo repositoryInfo)" returns = "DotNetPackSettings" +sig = "DotNetPackSettings UpdateRepositoryInfo(this DotNetPackSettings toolSettings, IRepositoryInfo repositoryInfo)" file = "NukeExtensions.cs" [[classes]] @@ -98,55 +626,346 @@ ns = "FEx.Building" file = "NukeLogger.cs" static = true +[[methods]] +parent = "NukeLogger" +name = "Get" +sig = "static ILogger Get()" +returns = "ILogger" +file = "NukeLogger.cs" +static = true + [[classes]] name = "NukeLogger" ns = "FEx.Building" base = "ILogger" file = "NukeLogger.cs" +[[properties]] +parent = "NukeLogger" +name = "Scope" +sig = "SemaphoreSlim? Scope { get; set; }" +returns = "SemaphoreSlim?" +file = "NukeLogger.cs" + +[[properties]] +parent = "NukeLogger" +name = "State" +sig = "object? State { get; set; }" +returns = "object?" +file = "NukeLogger.cs" + +[[methods]] +parent = "NukeLogger" +name = "BeginScope" +sig = "IDisposable? BeginScope(TState state) where TState : notnull" +returns = "IDisposable?" +file = "NukeLogger.cs" + +[[methods]] +parent = "NukeLogger" +name = "Log" +sig = "void Log(LogLevel logLevel, EventId eventId, TState state, Exception? exception, Func formatter)" +returns = "void" +file = "NukeLogger.cs" + +[[methods]] +parent = "NukeLogger" +name = "IsEnabled" +sig = "bool IsEnabled(LogLevel logLevel)" +returns = "bool" +file = "NukeLogger.cs" + [[classes]] name = "RepositoryInfo" ns = "FEx.Building" base = "IRepositoryInfo" file = "RepositoryInfo.cs" +[[properties]] +parent = "RepositoryInfo" +name = "CommitHash" +sig = "string CommitHash { get; }" +returns = "string" +file = "RepositoryInfo.cs" + +[[properties]] +parent = "RepositoryInfo" +name = "BranchName" +sig = "string BranchName { get; }" +returns = "string" +file = "RepositoryInfo.cs" + +[[properties]] +parent = "RepositoryInfo" +name = "Type" +sig = "string Type { get; }" +returns = "string" +file = "RepositoryInfo.cs" + +[[properties]] +parent = "RepositoryInfo" +name = "Url" +sig = "string Url { get; }" +returns = "string" +file = "RepositoryInfo.cs" + +[[ctors]] +parent = "RepositoryInfo" +sig = "RepositoryInfo(GitVersionInfo versionInfo, string repositoryUrl)" +file = "RepositoryInfo.cs" + +[[ctors]] +parent = "RepositoryInfo" +sig = "RepositoryInfo(string commitHash, string branchName, string repositoryUrl, string type = \"git\")" +file = "RepositoryInfo.cs" + +[[methods]] +parent = "RepositoryInfo" +name = "UpdateRepositoryInfo" +sig = "DotNetPackSettings UpdateRepositoryInfo(DotNetPackSettings settings)" +returns = "DotNetPackSettings" +file = "RepositoryInfo.cs" + [[classes]] name = "CSharpStringUpdateRule" ns = "FEx.Building.AssemblyInfo" base = "ICSharpUpdateRule" file = "AssemblyInfo\\CSharpStringUpdateRule.cs" +[[properties]] +parent = "CSharpStringUpdateRule" +name = "AttributeName" +sig = "string AttributeName { get; }" +returns = "string" +file = "AssemblyInfo\\CSharpStringUpdateRule.cs" + +[[ctors]] +parent = "CSharpStringUpdateRule" +sig = "CSharpStringUpdateRule(string attributeName, string updateRule)" +file = "AssemblyInfo\\CSharpStringUpdateRule.cs" + +[[methods]] +parent = "CSharpStringUpdateRule" +name = "Update" +sig = "string Update(string? v)" +returns = "string" +file = "AssemblyInfo\\CSharpStringUpdateRule.cs" + [[classes]] name = "CSharpUpdater" ns = "FEx.Building.AssemblyInfo" file = "AssemblyInfo\\CSharpUpdater.cs" +[[ctors]] +parent = "CSharpUpdater" +sig = "CSharpUpdater(string newAssemblyVersion, string? newAssemblyFileVersion = null, string? copyright = null, string? company = null)" +file = "AssemblyInfo\\CSharpUpdater.cs" + +[[methods]] +parent = "CSharpUpdater" +name = "Execute" +sig = "static bool Execute(string fileName, string assemblyVersion, string assemblyFileVersion, string copyright, string company)" +returns = "bool" +file = "AssemblyInfo\\CSharpUpdater.cs" +static = true + +[[methods]] +parent = "CSharpUpdater" +name = "GetAssemblyVersion" +sig = "static string? GetAssemblyVersion(string fileName)" +returns = "string?" +file = "AssemblyInfo\\CSharpUpdater.cs" +static = true + +[[methods]] +parent = "CSharpUpdater" +name = "GetAssemblyProperty" +sig = "static string? GetAssemblyProperty(string fileName, string propertyName, bool isVersionString = false)" +returns = "string?" +file = "AssemblyInfo\\CSharpUpdater.cs" +static = true + +[[methods]] +parent = "CSharpUpdater" +name = "UpdateLineWithRule" +sig = "static bool UpdateLineWithRule(ref string line, ICSharpUpdateRule updateRule)" +returns = "bool" +file = "AssemblyInfo\\CSharpUpdater.cs" +static = true + +[[methods]] +parent = "CSharpUpdater" +name = "GetVersionString" +sig = "static Group? GetVersionString(string input, string attributeName)" +returns = "Group?" +file = "AssemblyInfo\\CSharpUpdater.cs" +static = true + +[[methods]] +parent = "CSharpUpdater" +name = "GetValueString" +sig = "static Group? GetValueString(string input, string attributeName)" +returns = "Group?" +file = "AssemblyInfo\\CSharpUpdater.cs" +static = true + +[[methods]] +parent = "CSharpUpdater" +name = "UpdateFile" +sig = "void UpdateFile(string fileName)" +returns = "void" +file = "AssemblyInfo\\CSharpUpdater.cs" + [[classes]] name = "CSharpVersionUpdateRule" ns = "FEx.Building.AssemblyInfo" base = "ICSharpUpdateRule" file = "AssemblyInfo\\CSharpVersionUpdateRule.cs" +[[properties]] +parent = "CSharpVersionUpdateRule" +name = "AttributeName" +sig = "string AttributeName { get; }" +returns = "string" +file = "AssemblyInfo\\CSharpVersionUpdateRule.cs" + +[[ctors]] +parent = "CSharpVersionUpdateRule" +sig = "CSharpVersionUpdateRule(string attributeName, string updateRule)" +file = "AssemblyInfo\\CSharpVersionUpdateRule.cs" + +[[methods]] +parent = "CSharpVersionUpdateRule" +name = "Update" +sig = "string Update(string? v)" +returns = "string" +file = "AssemblyInfo\\CSharpVersionUpdateRule.cs" + +[[methods]] +parent = "CSharpVersionUpdateRule" +name = "Update" +sig = "string Update(VersionString v)" +returns = "string" +file = "AssemblyInfo\\CSharpVersionUpdateRule.cs" + [[interfaces]] name = "ICSharpUpdateRule" ns = "FEx.Building.AssemblyInfo" file = "AssemblyInfo\\ICSharpUpdateRule.cs" +[[properties]] +parent = "ICSharpUpdateRule" +name = "AttributeName" +sig = "string AttributeName { get; }" +returns = "string" +file = "AssemblyInfo\\ICSharpUpdateRule.cs" + +[[methods]] +parent = "ICSharpUpdateRule" +name = "Update" +sig = "string Update(string? v)" +returns = "string" +file = "AssemblyInfo\\ICSharpUpdateRule.cs" + [[classes]] name = "StringUpdateRule" ns = "FEx.Building.AssemblyInfo" file = "AssemblyInfo\\StringUpdateRule.cs" +[[ctors]] +parent = "StringUpdateRule" +sig = "StringUpdateRule(string rule)" +file = "AssemblyInfo\\StringUpdateRule.cs" + +[[methods]] +parent = "StringUpdateRule" +name = "Update" +sig = "string Update(string? version = null)" +returns = "string" +file = "AssemblyInfo\\StringUpdateRule.cs" + [[classes]] name = "VersionString" ns = "FEx.Building.AssemblyInfo" file = "AssemblyInfo\\VersionString.cs" +[[properties]] +parent = "VersionString" +name = "Major" +sig = "string Major { get; set; }" +returns = "string" +file = "AssemblyInfo\\VersionString.cs" + +[[properties]] +parent = "VersionString" +name = "Minor" +sig = "string Minor { get; set; }" +returns = "string" +file = "AssemblyInfo\\VersionString.cs" + +[[properties]] +parent = "VersionString" +name = "Build" +sig = "string Build { get; set; }" +returns = "string" +file = "AssemblyInfo\\VersionString.cs" + +[[properties]] +parent = "VersionString" +name = "Revision" +sig = "string Revision { get; set; }" +returns = "string" +file = "AssemblyInfo\\VersionString.cs" + +[[ctors]] +parent = "VersionString" +sig = "VersionString()" +file = "AssemblyInfo\\VersionString.cs" + +[[ctors]] +parent = "VersionString" +sig = "VersionString(string version)" +file = "AssemblyInfo\\VersionString.cs" + +[[methods]] +parent = "VersionString" +name = "TryParse" +sig = "static bool TryParse(string input, out VersionString? version)" +returns = "bool" +file = "AssemblyInfo\\VersionString.cs" +static = true + +[[methods]] +parent = "VersionString" +name = "ToString" +sig = "string ToString()" +returns = "string" +file = "AssemblyInfo\\VersionString.cs" + [[classes]] name = "VersionUpdateRule" ns = "FEx.Building.AssemblyInfo" file = "AssemblyInfo\\VersionUpdateRule.cs" +[[ctors]] +parent = "VersionUpdateRule" +sig = "VersionUpdateRule(string rule)" +file = "AssemblyInfo\\VersionUpdateRule.cs" + +[[methods]] +parent = "VersionUpdateRule" +name = "Update" +sig = "string Update(string? version)" +returns = "string" +file = "AssemblyInfo\\VersionUpdateRule.cs" + +[[methods]] +parent = "VersionUpdateRule" +name = "Update" +sig = "string Update(VersionString version)" +returns = "string" +file = "AssemblyInfo\\VersionUpdateRule.cs" + [[classes]] name = "JoinableTaskHelper" ns = "FEx.Building.Helpers" @@ -154,3 +973,19 @@ summary = "Minimal JoinableTask wrapper for running async code synchronously in file = "Helpers\\JoinableTaskHelper.cs" static = true +[[methods]] +parent = "JoinableTaskHelper" +name = "Run" +sig = "static void Run(Func asyncMethod)" +returns = "void" +file = "Helpers\\JoinableTaskHelper.cs" +static = true + +[[methods]] +parent = "JoinableTaskHelper" +name = "Run" +sig = "static T Run(Func> asyncMethod)" +returns = "T" +file = "Helpers\\JoinableTaskHelper.cs" +static = true + diff --git a/.api-surface/FEx/CLI.toml b/.api-surface/FEx/CLI.toml index ecfe6d60..f18e33af 100644 --- a/.api-surface/FEx/CLI.toml +++ b/.api-surface/FEx/CLI.toml @@ -8,8 +8,170 @@ ns = "FEx.CLI" file = "CommandLineParserHelper.cs" static = true +[[methods]] +parent = "CommandLineParserHelper" +name = "GetConfiguration" +sig = "static T GetConfiguration(string[] args)" +returns = "T" +file = "CommandLineParserHelper.cs" +static = true + [[classes]] name = "ErrorData" ns = "FEx.CLI" file = "ErrorData.cs" +[[properties]] +parent = "ErrorData" +name = "Tag" +sig = "ErrorType Tag { get; }" +returns = "ErrorType" +file = "ErrorData.cs" + +[[properties]] +parent = "ErrorData" +name = "NameInfoString" +sig = "string NameInfoString { get; }" +returns = "string" +file = "ErrorData.cs" + +[[properties]] +parent = "ErrorData" +name = "Token" +sig = "string Token { get; }" +returns = "string" +file = "ErrorData.cs" + +[[properties]] +parent = "ErrorData" +name = "SetName" +sig = "string SetName { get; }" +returns = "string" +file = "ErrorData.cs" + +[[properties]] +parent = "ErrorData" +name = "Verb" +sig = "string Verb { get; }" +returns = "string" +file = "ErrorData.cs" + +[[properties]] +parent = "ErrorData" +name = "Exception" +sig = "Exception Exception { get; }" +returns = "Exception" +file = "ErrorData.cs" + +[[properties]] +parent = "ErrorData" +name = "NameInfo" +sig = "NameInfo NameInfo { get; }" +returns = "NameInfo" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(ErrorType tag, NameInfo nameInfo, string token, string setName, string verb, Exception exception)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(ErrorType tag)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(ErrorType tag, NameInfo nameInfo)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(BadFormatTokenError e)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(MissingValueOptionError e)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(UnknownOptionError e)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(MissingRequiredOptionError e)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(MutuallyExclusiveSetError e)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(BadFormatConversionError e)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(SequenceOutOfRangeError e)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(RepeatedOptionError e)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(NoVerbSelectedError e)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(BadVerbSelectedError e)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(HelpRequestedError e)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(HelpVerbRequestedError e)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(VersionRequestedError e)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(SetValueExceptionError e)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(InvalidAttributeConfigurationError e)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(MissingGroupOptionError e)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(GroupOptionAmbiguityError e)" +file = "ErrorData.cs" + +[[ctors]] +parent = "ErrorData" +sig = "ErrorData(MultipleDefaultVerbsError e)" +file = "ErrorData.cs" + diff --git a/.api-surface/FEx/Common.Abstractions.toml b/.api-surface/FEx/Common.Abstractions.toml index e9d1245b..c1dd4c1d 100644 --- a/.api-surface/FEx/Common.Abstractions.toml +++ b/.api-surface/FEx/Common.Abstractions.toml @@ -16,8 +16,8 @@ static = true [[extensions]] name = "WaitForInternetAsync" -sig = "ValueTask WaitForInternetAsync(this IDeviceHelper helper)" returns = "ValueTask" +sig = "ValueTask WaitForInternetAsync(this IDeviceHelper helper)" file = "Extensions\\DeviceHelperExtensions.cs" [[classes]] @@ -28,8 +28,8 @@ static = true [[extensions]] name = "HasInternet" -sig = "bool HasInternet(this IFExInternetConnectionHelper helper)" returns = "bool" +sig = "bool HasInternet(this IFExInternetConnectionHelper helper)" file = "Extensions\\FExInternetConnectionHelperExtensions.cs" [[classes]] @@ -38,15 +38,60 @@ ns = "FEx.Common.Abstractions.Helpers" file = "Helpers\\DateTimeProvider.cs" static = true +[[properties]] +parent = "DateTimeProvider" +name = "Today" +sig = "static DateTime Today { get; }" +returns = "DateTime" +file = "Helpers\\DateTimeProvider.cs" +static = true + +[[properties]] +parent = "DateTimeProvider" +name = "Now" +sig = "static DateTime Now { get; }" +returns = "DateTime" +file = "Helpers\\DateTimeProvider.cs" +static = true + +[[properties]] +parent = "DateTimeProvider" +name = "UtcNow" +sig = "static DateTime UtcNow { get; }" +returns = "DateTime" +file = "Helpers\\DateTimeProvider.cs" +static = true + [[classes]] name = "DateTimeProviderContext" ns = "FEx.Common.Abstractions.Helpers" base = "IDisposable" file = "Helpers\\DateTimeProviderContext.cs" +[[properties]] +parent = "DateTimeProviderContext" +name = "Current" +sig = "static DateTimeProviderContext Current { get; }" +returns = "DateTimeProviderContext" +file = "Helpers\\DateTimeProviderContext.cs" +static = true + +[[ctors]] +parent = "DateTimeProviderContext" +sig = "DateTimeProviderContext(DateTime contextDateTime)" +file = "Helpers\\DateTimeProviderContext.cs" + +[[methods]] +parent = "DateTimeProviderContext" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Helpers\\DateTimeProviderContext.cs" + [[interfaces]] name = "IConnectivityChangedSubject" ns = "FEx.Common.Abstractions.Interfaces" +base = "IFExBehaviorSubject" file = "Interfaces\\IConnectivityChangedSubject.cs" [[interfaces]] @@ -54,19 +99,38 @@ name = "IDeviceHelper" ns = "FEx.Common.Abstractions.Interfaces" file = "Interfaces\\IDeviceHelper.cs" +[[properties]] +parent = "IDeviceHelper" +name = "HasInternet" +sig = "bool HasInternet { get; }" +returns = "bool" +summary = "True if the device is currently connected to the internet." +file = "Interfaces\\IDeviceHelper.cs" + +[[methods]] +parent = "IDeviceHelper" +name = "WaitForInternetAsync" +sig = "ValueTask WaitForInternetAsync(CancellationToken cancellationToken)" +returns = "ValueTask" +summary = "Waits for a device to be connected to internet, or returns straight away if it already is." +file = "Interfaces\\IDeviceHelper.cs" + [[interfaces]] name = "IFExAppSettings" ns = "FEx.Common.Abstractions.Interfaces" +base = "ISentryConfig, IAppThreadingSettings" file = "Interfaces\\IFExAppSettings.cs" [[interfaces]] name = "IFExBaseContainer" ns = "FEx.Common.Abstractions.Interfaces" +base = "IFExCommonContainer, IFExDependencyInjectionContainer, IFExCoreContainer, IFExLoggingContainer" file = "Interfaces\\IFExBaseContainer.cs" [[interfaces]] name = "IFExCommonContainer" ns = "FEx.Common.Abstractions.Interfaces" +base = "IContainer, IContainer, IContainer, IContainer" file = "Interfaces\\IFExCommonContainer.cs" [[interfaces]] @@ -74,13 +138,119 @@ name = "IFExInternetConnectionHelper" ns = "FEx.Common.Abstractions.Interfaces" file = "Interfaces\\IFExInternetConnectionHelper.cs" +[[methods]] +parent = "IFExInternetConnectionHelper" +name = "HasInternet" +sig = "bool HasInternet(bool triggersCallbackOnLackOfInternet)" +returns = "bool" +summary = "Checks if device is connected to internet and returns straight away if it already is, or executes OnLackOfInternetAsync if not." +file = "Interfaces\\IFExInternetConnectionHelper.cs" + [[interfaces]] name = "IStatusHub" ns = "FEx.Common.Abstractions.Interfaces" file = "Interfaces\\IStatusHub.cs" +[[properties]] +parent = "IStatusHub" +name = "Key" +sig = "Guid Key { get; }" +returns = "Guid" +file = "Interfaces\\IStatusHub.cs" + +[[methods]] +parent = "IStatusHub" +name = "AddStatus" +sig = "Guid AddStatus(string status, bool unique = true)" +returns = "Guid" +file = "Interfaces\\IStatusHub.cs" + +[[methods]] +parent = "IStatusHub" +name = "AttachToStatusChanges" +sig = "void AttachToStatusChanges(Action onStatusAdded, Action onStatusRemoved, Action onStatusesReset)" +returns = "void" +file = "Interfaces\\IStatusHub.cs" + +[[methods]] +parent = "IStatusHub" +name = "CleanStatuses" +sig = "void CleanStatuses()" +returns = "void" +file = "Interfaces\\IStatusHub.cs" + +[[methods]] +parent = "IStatusHub" +name = "GetStatuses" +sig = "IList GetStatuses()" +returns = "IList" +file = "Interfaces\\IStatusHub.cs" + +[[methods]] +parent = "IStatusHub" +name = "GetStatusString" +sig = "string GetStatusString(string separator = null)" +returns = "string" +file = "Interfaces\\IStatusHub.cs" + +[[methods]] +parent = "IStatusHub" +name = "RemoveStatus" +sig = "void RemoveStatus(Guid key)" +returns = "void" +file = "Interfaces\\IStatusHub.cs" + +[[methods]] +parent = "IStatusHub" +name = "Log" +sig = "DisposableAction Log(string status, bool unique = true)" +returns = "DisposableAction" +file = "Interfaces\\IStatusHub.cs" + [[interfaces]] name = "IStatusService" ns = "FEx.Common.Abstractions.Interfaces" file = "Interfaces\\IStatusService.cs" +[[properties]] +parent = "IStatusService" +name = "MainHub" +sig = "IStatusHub MainHub { get; }" +returns = "IStatusHub" +file = "Interfaces\\IStatusService.cs" + +[[properties]] +parent = "IStatusService" +name = "MainHubKey" +sig = "Guid? MainHubKey { get; }" +returns = "Guid?" +file = "Interfaces\\IStatusService.cs" + +[[methods]] +parent = "IStatusService" +name = "GetOrAdd" +sig = "IStatusHub GetOrAdd(Guid? key = null, Action onStatusAdded = null, Action onStatusRemoved = null, Action onStatusesReset = null, bool markAsMain = false)" +returns = "IStatusHub" +file = "Interfaces\\IStatusService.cs" + +[[methods]] +parent = "IStatusService" +name = "LogToMainHub" +sig = "Guid LogToMainHub(string status, bool unique = true)" +returns = "Guid" +file = "Interfaces\\IStatusService.cs" + +[[methods]] +parent = "IStatusService" +name = "RemoveMainLog" +sig = "void RemoveMainLog(Guid statusKey)" +returns = "void" +file = "Interfaces\\IStatusService.cs" + +[[methods]] +parent = "IStatusService" +name = "Log" +sig = "DisposableAction Log(string status, IStatusHub hub = null, bool unique = true)" +returns = "DisposableAction" +file = "Interfaces\\IStatusService.cs" + diff --git a/.api-surface/FEx/Common.toml b/.api-surface/FEx/Common.toml index 1ac6ffb0..90e66182 100644 --- a/.api-surface/FEx/Common.toml +++ b/.api-surface/FEx/Common.toml @@ -8,39 +8,188 @@ ns = "FEx.Common" base = "InitializeModule" file = "FExBaseModule.cs" +[[methods]] +parent = "FExBaseModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExBaseContainer container, IServiceCollection context)" +returns = "void" +file = "FExBaseModule.cs" + [[classes]] name = "FExCommonModule" ns = "FEx.Common" base = "InitializeModule" file = "FExCommonModule.cs" +[[methods]] +parent = "FExCommonModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExCommonContainer container, IServiceCollection services)" +returns = "void" +file = "FExCommonModule.cs" + [[classes]] name = "DeviceHelper" ns = "FEx.Common.Helpers" base = "IDeviceHelper" file = "Helpers\\DeviceHelper.cs" +[[properties]] +parent = "DeviceHelper" +name = "HasInternet" +sig = "bool HasInternet { get; }" +returns = "bool" +file = "Helpers\\DeviceHelper.cs" + +[[ctors]] +parent = "DeviceHelper" +sig = "DeviceHelper(IConnectivityChangedSubject connectivityChangedSubject)" +file = "Helpers\\DeviceHelper.cs" + +[[methods]] +parent = "DeviceHelper" +name = "WaitForInternetAsync" +sig = "ValueTask WaitForInternetAsync(CancellationToken cancellationToken)" +returns = "ValueTask" +file = "Helpers\\DeviceHelper.cs" + [[classes]] name = "FExInternetConnectionHelper" ns = "FEx.Common.Implementations" base = "IFExInternetConnectionHelper" file = "Implementations\\FExInternetConnectionHelper.cs" +[[ctors]] +parent = "FExInternetConnectionHelper" +sig = "FExInternetConnectionHelper(IDeviceHelper deviceHelper, IAsyncHelper asyncHelper)" +file = "Implementations\\FExInternetConnectionHelper.cs" + +[[methods]] +parent = "FExInternetConnectionHelper" +name = "HasInternet" +sig = "bool HasInternet(bool triggersCallbackOnLackOfInternet)" +returns = "bool" +file = "Implementations\\FExInternetConnectionHelper.cs" + +[[methods]] +parent = "FExInternetConnectionHelper" +name = "OnLackOfInternetAsync" +sig = "Task OnLackOfInternetAsync()" +returns = "Task" +file = "Implementations\\FExInternetConnectionHelper.cs" + [[classes]] name = "MainThreadDispatcher" ns = "FEx.Common.Implementations" base = "FExDispatcher" file = "Implementations\\MainThreadDispatcher.cs" +[[ctors]] +parent = "MainThreadDispatcher" +sig = "MainThreadDispatcher(IMainThreadContextProvider mainThreadContextProvider, ILogger logger, IDeadlockMonitor deadlockMonitor, IAppThreadingSettings appInstanceSettings, IStackTraceProvider stackTraceProvider)" +file = "Implementations\\MainThreadDispatcher.cs" + +[[methods]] +parent = "MainThreadDispatcher" +name = "CheckAccess" +sig = "bool CheckAccess(object sender = null)" +returns = "bool" +file = "Implementations\\MainThreadDispatcher.cs" + +[[methods]] +parent = "MainThreadDispatcher" +name = "BeginInvokeOnMainThread" +sig = "void BeginInvokeOnMainThread(Action action, object sender = null)" +returns = "void" +file = "Implementations\\MainThreadDispatcher.cs" + +[[methods]] +parent = "MainThreadDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func action, object sender = null)" +returns = "Task" +file = "Implementations\\MainThreadDispatcher.cs" + +[[methods]] +parent = "MainThreadDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Action action, object sender = null)" +returns = "Task" +file = "Implementations\\MainThreadDispatcher.cs" + +[[methods]] +parent = "MainThreadDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func> funcTask, object sender = null)" +returns = "Task" +file = "Implementations\\MainThreadDispatcher.cs" + +[[methods]] +parent = "MainThreadDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func funcTask, object sender = null)" +returns = "Task" +file = "Implementations\\MainThreadDispatcher.cs" + +[[methods]] +parent = "MainThreadDispatcher" +name = "EnableCollectionSynchronization" +sig = "void EnableCollectionSynchronization(IEnumerable collection, object context, Action callback)" +returns = "void" +file = "Implementations\\MainThreadDispatcher.cs" + [[classes]] name = "SimpleMainThreadContextProvider" ns = "FEx.Common.Implementations" base = "IMainThreadContextProvider" file = "Implementations\\SimpleMainThreadContextProvider.cs" +[[properties]] +parent = "SimpleMainThreadContextProvider" +name = "Thread" +sig = "Thread Thread { get; }" +returns = "Thread" +file = "Implementations\\SimpleMainThreadContextProvider.cs" + +[[properties]] +parent = "SimpleMainThreadContextProvider" +name = "IsDispatcherContext" +sig = "bool IsDispatcherContext { get; set; }" +returns = "bool" +file = "Implementations\\SimpleMainThreadContextProvider.cs" + +[[properties]] +parent = "SimpleMainThreadContextProvider" +name = "Context" +sig = "SynchronizationContext Context { get; }" +returns = "SynchronizationContext" +file = "Implementations\\SimpleMainThreadContextProvider.cs" + +[[ctors]] +parent = "SimpleMainThreadContextProvider" +sig = "SimpleMainThreadContextProvider()" +file = "Implementations\\SimpleMainThreadContextProvider.cs" + +[[methods]] +parent = "SimpleMainThreadContextProvider" +name = "SetMainThread" +sig = "void SetMainThread(bool throwOnNonMainThread = true)" +returns = "void" +file = "Implementations\\SimpleMainThreadContextProvider.cs" + [[classes]] name = "ConnectivityChangedSubject" ns = "FEx.Common.Subjects" base = "FExBehaviorSubject, IConnectivityChangedSubject" file = "Subjects\\ConnectivityChangedSubject.cs" +[[ctors]] +parent = "ConnectivityChangedSubject" +sig = "ConnectivityChangedSubject()" +file = "Subjects\\ConnectivityChangedSubject.cs" + +[[ctors]] +parent = "ConnectivityChangedSubject" +sig = "ConnectivityChangedSubject(FExNetworkAccess networkAccess)" +file = "Subjects\\ConnectivityChangedSubject.cs" + diff --git a/.api-surface/FEx/Core.Abstractions.toml b/.api-surface/FEx/Core.Abstractions.toml index ba277ba3..4fe4c234 100644 --- a/.api-surface/FEx/Core.Abstractions.toml +++ b/.api-surface/FEx/Core.Abstractions.toml @@ -8,26 +8,372 @@ ns = "FEx.Core.Abstractions" base = "StaticsBase" file = "FExCoreStatics.cs" -[[classes]] -name = "IsExternalInit" -ns = "System.Runtime.CompilerServices" -file = "IsExternalInit.cs" +[[properties]] +parent = "FExCoreStatics" +name = "AsyncHelper" +sig = "static IAsyncHelper AsyncHelper { get; }" +returns = "IAsyncHelper" +summary = "Retrieves the instance. ⚠️ This is discouraged and should only be used where Dependency Injection is unavailable." +file = "FExCoreStatics.cs" +static = true + +[[properties]] +parent = "FExCoreStatics" +name = "StackTraceProvider" +sig = "static IStackTraceProvider StackTraceProvider { get; }" +returns = "IStackTraceProvider" +summary = "Retrieves the instance. ⚠️ This is discouraged and should only be used where Dependency Injection is unavailable." +file = "FExCoreStatics.cs" +static = true + +[[properties]] +parent = "FExCoreStatics" +name = "Logger" +sig = "static ILogger Logger { get; }" +returns = "ILogger" +summary = "Retrieves the instance. ⚠️ This is discouraged and should only be used where Dependency Injection is unavailable." +file = "FExCoreStatics.cs" +static = true + +[[properties]] +parent = "FExCoreStatics" +name = "DeadlockMonitor" +sig = "static IDeadlockMonitor DeadlockMonitor { get; }" +returns = "IDeadlockMonitor" +summary = "Retrieves the instance. ⚠️ This is discouraged and should only be used where Dependency Injection is unavailable." +file = "FExCoreStatics.cs" +static = true + +[[properties]] +parent = "FExCoreStatics" +name = "Dispatcher" +sig = "static IFExDispatcher Dispatcher { get; }" +returns = "IFExDispatcher" +summary = "Retrieves the instance. ⚠️ This is discouraged and should only be used where Dependency Injection is unavailable." +file = "FExCoreStatics.cs" +static = true + +[[properties]] +parent = "FExCoreStatics" +name = "ExceptionHandler" +sig = "static IExceptionHandler ExceptionHandler { get; }" +returns = "IExceptionHandler" +summary = "Retrieves the instance. ⚠️ This is discouraged and should only be used where Dependency Injection is unavailable." +file = "FExCoreStatics.cs" +static = true + +[[properties]] +parent = "FExCoreStatics" +name = "MainThreadContextProvider" +sig = "static IMainThreadContextProvider MainThreadContextProvider { get; }" +returns = "IMainThreadContextProvider" +file = "FExCoreStatics.cs" +static = true + +[[properties]] +parent = "FExCoreStatics" +name = "AppInfoProvider" +sig = "static IAppInfoProvider AppInfoProvider { get; }" +returns = "IAppInfoProvider" +file = "FExCoreStatics.cs" +static = true + +[[properties]] +parent = "FExCoreStatics" +name = "SynchronizedAccessService" +sig = "static ISynchronizedAccessService SynchronizedAccessService { get; }" +returns = "ISynchronizedAccessService" +summary = "Retrieves the instance. ⚠️ This is discouraged and should only be used where Dependency Injection is unavailable." +file = "FExCoreStatics.cs" +static = true + +[[properties]] +parent = "FExCoreStatics" +name = "AlphanumComparatorFast" +sig = "static AlphanumComparatorFast AlphanumComparatorFast { get; }" +returns = "AlphanumComparatorFast" +file = "FExCoreStatics.cs" +static = true + +[[methods]] +parent = "FExCoreStatics" +name = "SetDefaults" +sig = "static void SetDefaults()" +returns = "void" +file = "FExCoreStatics.cs" +static = true + +[[methods]] +parent = "FExCoreStatics" +name = "Configure" +sig = "static void Configure(Func stackTraceProviderFactory = null, Func dispatcherFactory = null, Func asyncHelperFactory = null, Func loggerFactory = null, Func mainThreadContextProviderFactory = null, Func deadlockMonitorFactory = null, Func appInfoProviderFactory = null, Func exceptionHandlerFactory = null, Func synchronizedAccessServiceFactory = null, Func alphanumComparatorFastFactory = null)" +returns = "void" +file = "FExCoreStatics.cs" static = true [[classes]] name = "ObservableHashSet" ns = "FEx.Core.Abstractions.Collections" -base = "BaseConcurrentList, ISet, IReadOnlyCollection, INotifyCollectionChanged, - INotifyPropertyChanged" +base = "BaseConcurrentList, ISet, IReadOnlyCollection, INotifyCollectionChanged, INotifyPropertyChanged" summary = "A hash set that implements the interfaces required for Entity Framework to use notification based change tracking for a collection navigation property." file = "Collections\\ObservableHashSet.cs" +[[properties]] +parent = "ObservableHashSet" +name = "NoItems" +sig = "static T[] NoItems { get; }" +returns = "T[]" +file = "Collections\\ObservableHashSet.cs" +static = true + +[[properties]] +parent = "ObservableHashSet" +name = "Count" +sig = "int Count { get; }" +returns = "int" +summary = "Gets the number of elements that are contained in the hash set." +file = "Collections\\ObservableHashSet.cs" + +[[properties]] +parent = "ObservableHashSet" +name = "IsReadOnly" +sig = "bool IsReadOnly { get; }" +returns = "bool" +summary = "Gets a value indicating whether the hash set is read-only." +file = "Collections\\ObservableHashSet.cs" + +[[properties]] +parent = "ObservableHashSet" +name = "Comparer" +sig = "IEqualityComparer Comparer { get; }" +returns = "IEqualityComparer" +summary = "Gets the object that is used to determine equality for the values in the set." +file = "Collections\\ObservableHashSet.cs" + +[[ctors]] +parent = "ObservableHashSet" +sig = "ObservableHashSet()" +summary = "Initializes a new instance of the class that is empty and uses the default equality comparer for the set type." +file = "Collections\\ObservableHashSet.cs" + +[[ctors]] +parent = "ObservableHashSet" +sig = "ObservableHashSet(IEnumerable collection = null, IEqualityComparer comparer = null)" +summary = "Initializes a new instance of the class that uses the specified equality comparer for the set type, contains elements copied from the specified collection, and has sufficient capacity to accommodate the number of elements copied." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "Clear" +sig = "void Clear()" +returns = "void" +summary = "Removes all elements from the hash set." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "Contains" +sig = "bool Contains(T item)" +returns = "bool" +summary = "Determines whether the hash set object contains the specified element." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "CopyTo" +sig = "void CopyTo(T[] array, int arrayIndex)" +returns = "void" +summary = "Copies the elements of the hash set to an array, starting at the specified array index." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "Remove" +sig = "bool Remove(T item)" +returns = "bool" +summary = "Removes the specified element from the hash set." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "Add" +sig = "bool Add(T item)" +returns = "bool" +summary = "Adds the specified element to the hash set." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "UnionWith" +sig = "void UnionWith(IEnumerable other)" +returns = "void" +summary = "Modifies the hash set to contain all elements that are present in itself, the specified collection, or both." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "IntersectWith" +sig = "void IntersectWith(IEnumerable other)" +returns = "void" +summary = "Modifies the current hash set to contain only elements that are present in that object and in the specified collection." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "ExceptWith" +sig = "void ExceptWith(IEnumerable other)" +returns = "void" +summary = "Removes all elements in the specified collection from the hash set." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "SymmetricExceptWith" +sig = "void SymmetricExceptWith(IEnumerable other)" +returns = "void" +summary = "Modifies the current hash set to contain only elements that are present either in that object or in the specified collection, but not both." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "IsSubsetOf" +sig = "bool IsSubsetOf(IEnumerable other)" +returns = "bool" +summary = "Determines whether the hash set is a subset of the specified collection." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "IsProperSubsetOf" +sig = "bool IsProperSubsetOf(IEnumerable other)" +returns = "bool" +summary = "Determines whether the hash set is a proper subset of the specified collection." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "IsSupersetOf" +sig = "bool IsSupersetOf(IEnumerable other)" +returns = "bool" +summary = "Determines whether the hash set is a superset of the specified collection." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "IsProperSupersetOf" +sig = "bool IsProperSupersetOf(IEnumerable other)" +returns = "bool" +summary = "Determines whether the hash set is a proper superset of the specified collection." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "Overlaps" +sig = "bool Overlaps(IEnumerable other)" +returns = "bool" +summary = "Determines whether the current object and a specified collection share common elements." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "SetEquals" +sig = "bool SetEquals(IEnumerable other)" +returns = "bool" +summary = "Determines whether the hash set and the specified collection contain the same elements." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "GetEnumerator" +sig = "HashSet.Enumerator GetEnumerator()" +returns = "HashSet.Enumerator" +summary = "Returns an enumerator that iterates through the hash set." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "CopyTo" +sig = "void CopyTo([NotNull] T[] array)" +returns = "void" +summary = "Copies the elements of the hash set to an array." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "CopyTo" +sig = "void CopyTo([NotNull] T[] array, int arrayIndex, int count)" +returns = "void" +summary = "Copies the specified number of elements of the hash set to an array, starting at the specified array index." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "RemoveWhere" +sig = "int RemoveWhere([NotNull] Predicate match)" +returns = "int" +summary = "Removes all elements that match the conditions defined by the specified predicate from the hash set." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "TrimExcess" +sig = "void TrimExcess()" +returns = "void" +summary = "Sets the capacity of the hash set to the actual number of elements it contains, rounded up to a nearby, implementation-specific value." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "Dispatch" +sig = "void Dispatch(Action action)" +returns = "void" +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "OnPropertyChanged" +sig = "void OnPropertyChanged(PropertyChangedEventArgs e)" +returns = "void" +summary = "Raises a PropertyChanged event (per )." +file = "Collections\\ObservableHashSet.cs" + +[[methods]] +parent = "ObservableHashSet" +name = "OnCollectionChanged" +sig = "void OnCollectionChanged(NotifyCollectionChangedEventArgs e)" +returns = "void" +file = "Collections\\ObservableHashSet.cs" + [[classes]] name = "ExceptionEventArgs" ns = "FEx.Core.Abstractions.CustomEventArgs" base = "EventArgs" file = "CustomEventArgs\\ExceptionEventArgs.cs" +[[properties]] +parent = "ExceptionEventArgs" +name = "Exception" +sig = "Exception Exception { get; }" +returns = "Exception" +file = "CustomEventArgs\\ExceptionEventArgs.cs" + +[[properties]] +parent = "ExceptionEventArgs" +name = "Custom" +sig = "IDictionary Custom { get; }" +returns = "IDictionary" +file = "CustomEventArgs\\ExceptionEventArgs.cs" + +[[ctors]] +parent = "ExceptionEventArgs" +sig = "ExceptionEventArgs(Exception ex, params (string, object)[] custom)" +file = "CustomEventArgs\\ExceptionEventArgs.cs" + +[[ctors]] +parent = "ExceptionEventArgs" +sig = "ExceptionEventArgs(Exception ex, IDictionary custom = null)" +file = "CustomEventArgs\\ExceptionEventArgs.cs" + [[enums]] name = "NavigationFlow" ns = "FEx.Core.Abstractions.Enums" @@ -41,14 +387,14 @@ static = true [[extensions]] name = "Execute" -sig = "void Execute(this IDeadlockMonitor monitor, Action action)" returns = "void" +sig = "void Execute(this IDeadlockMonitor monitor, Action action)" file = "Extensions\\DeadlockMonitorExtensions.cs" [[extensions]] name = "Execute" -sig = "void Execute(this IDeadlockMonitor monitor, Action action, uint timeout)" returns = "void" +sig = "void Execute(this IDeadlockMonitor monitor, Action action, uint timeout)" file = "Extensions\\DeadlockMonitorExtensions.cs" [[classes]] @@ -57,6 +403,18 @@ ns = "FEx.Core.Abstractions.Extensions" file = "Extensions\\EventsExtensions.cs" static = true +[[extensions]] +name = "SetPropertyStatic" +returns = "bool" +sig = "bool SetPropertyStatic(this TObj sender, ref TRet backingField, TRet newValue, Action propertyChanged, [CallerMemberName] string propertyName = null)" +file = "Extensions\\EventsExtensions.cs" + +[[extensions]] +name = "OnPropertyChangedStatic" +returns = "void" +sig = "void OnPropertyChangedStatic(this TObj sender, Action propertyChanged, [CallerMemberName] string propertyName = null)" +file = "Extensions\\EventsExtensions.cs" + [[classes]] name = "ExceptionExtensions" ns = "FEx.Core.Abstractions.Extensions" @@ -65,24 +423,20 @@ static = true [[extensions]] name = "HandleException" -sig = "void HandleException(this Exception exception)" returns = "void" +sig = "void HandleException(this Exception exception)" file = "Extensions\\ExceptionExtensions.cs" [[extensions]] name = "HandleException" -sig = "void HandleException(this Exception exception, IExceptionHandlerOptions options)" returns = "void" +sig = "void HandleException(this Exception exception, IExceptionHandlerOptions options)" file = "Extensions\\ExceptionExtensions.cs" [[extensions]] name = "HandleException" -sig = "void HandleException(this Exception ex, - bool informUser = false, - bool wait = false, - bool doNotReport = false, - params (string, object)" returns = "void" +sig = "void HandleException(this Exception ex, bool informUser = false, bool wait = false, bool doNotReport = false, params (string, object)[] custom)" file = "Extensions\\ExceptionExtensions.cs" [[classes]] @@ -93,8 +447,8 @@ static = true [[extensions]] name = "SendInContext" -sig = "void SendInContext(this IFExDispatcher dispatcher, Action action, object sender)" returns = "void" +sig = "void SendInContext(this IFExDispatcher dispatcher, Action action, object sender)" file = "Extensions\\FExDispatcherExtensions.cs" [[classes]] @@ -103,6 +457,112 @@ ns = "FEx.Core.Abstractions.Extensions" file = "Extensions\\ObservableExtensions.cs" static = true +[[extensions]] +name = "SelectTask" +returns = "IObservable" +sig = "IObservable SelectTask(this IObservable source, Func> func, CancellationToken cancellationToken = default)" +file = "Extensions\\ObservableExtensions.cs" + +[[extensions]] +name = "SelectTask" +returns = "IObservable" +sig = "IObservable SelectTask(this IObservable source, Func func, CancellationToken cancellationToken = default)" +file = "Extensions\\ObservableExtensions.cs" + +[[extensions]] +name = "SubscribeTask" +returns = "IDisposable" +sig = "IDisposable SubscribeTask(this IObservable source, Func func, CancellationToken cancellationToken = default)" +file = "Extensions\\ObservableExtensions.cs" + +[[extensions]] +name = "SubscribeTask" +returns = "void" +sig = "void SubscribeTask(this IObservable source, Func func, CompositeDisposable disposable, CancellationToken cancellationToken = default)" +file = "Extensions\\ObservableExtensions.cs" + +[[extensions]] +name = "GetPropertyChangedObservable" +returns = "IObservable>" +sig = "IObservable> GetPropertyChangedObservable( this INotifyPropertyChanged notifyPropertyChanged, string propertyName = null)" +file = "Extensions\\ObservableExtensions.cs" + +[[extensions]] +name = "GetCollectionChangedObservable" +returns = "IObservable>" +sig = "IObservable> GetCollectionChangedObservable(this INotifyCollectionChanged notifyCollectionChanged)" +file = "Extensions\\ObservableExtensions.cs" + +[[extensions]] +name = "MergeMany" +returns = "IObservable" +sig = "IObservable MergeMany(this IObservable source, params IObservable[] observables)" +file = "Extensions\\ObservableExtensions.cs" + +[[extensions]] +name = "AsyncSubscribe" +returns = "IDisposable" +sig = "IDisposable AsyncSubscribe(this IObservable source, Action onNext = null)" +file = "Extensions\\ObservableExtensions.cs" + +[[extensions]] +name = "AsyncSubscribe" +returns = "void" +sig = "void AsyncSubscribe(this IObservable source, Action onNext, CompositeDisposable disposable)" +file = "Extensions\\ObservableExtensions.cs" + +[[extensions]] +name = "GetResultAsync" +returns = "ValueTask>" +sig = "ValueTask> GetResultAsync(this IObservable observable, CancellationToken cancellationToken = default)" +summary = "Waits for the observable to retrieve a value and returns it wrapped in Result." +file = "Extensions\\ObservableExtensions.cs" + +[[extensions]] +name = "ToTaskAsync" +returns = "Task" +sig = "Task ToTaskAsync(this IObservable observable, CancellationToken cancellationToken = default)" +summary = "Returns a task that will receive the last value or the exception produced by the observable sequence." +file = "Extensions\\ObservableExtensions.cs" + +[[extensions]] +name = "GetResult" +returns = "Result" +sig = "Result GetResult(this IObservable observable)" +summary = "Tries to get the value from the observable and returns it wrapped in Result." +file = "Extensions\\ObservableExtensions.cs" + +[[extensions]] +name = "DisposeUsing" +returns = "T" +sig = "T DisposeUsing(this T item, CompositeDisposable compositeDisposable)" +summary = "Ensures the provided disposable is disposed using the specified ." +file = "Extensions\\ObservableExtensions.cs" + +[[extensions]] +name = "TryGetLastValue" +returns = "void" +sig = "void TryGetLastValue(this IObservable source, out TResult value)" +file = "Extensions\\ObservableExtensions.cs" + +[[extensions]] +name = "SubscribeWithoutOverlap" +returns = "IDisposable" +sig = "IDisposable SubscribeWithoutOverlap(this IObservable source, Action action)" +file = "Extensions\\ObservableExtensions.cs" + +[[extensions]] +name = "FromTdf" +returns = "IObservable" +sig = "IObservable FromTdf(this IObservable source, Func> blockFactory)" +file = "Extensions\\ObservableExtensions.cs" + +[[extensions]] +name = "FromTdf" +returns = "IObservable" +sig = "IObservable FromTdf(this IObservable source, Func> transformFunc)" +file = "Extensions\\ObservableExtensions.cs" + [[classes]] name = "SynchronizationContextExtensions" ns = "FEx.Core.Abstractions.Extensions" @@ -111,23 +571,34 @@ static = true [[extensions]] name = "GetThreadSynchronizationContext" +returns = "SynchronizationContext" sig = "SynchronizationContext GetThreadSynchronizationContext(this Thread thread, bool createNew = false)" +file = "Extensions\\SynchronizationContextExtensions.cs" + +[[methods]] +parent = "SynchronizationContextExtensions" +name = "Get" +sig = "static SynchronizationContext Get(bool createNew = false)" returns = "SynchronizationContext" file = "Extensions\\SynchronizationContextExtensions.cs" +static = true + +[[extensions]] +name = "SendInContext" +returns = "T" +sig = "T SendInContext(this SynchronizationContext context, object sender, Func func)" +file = "Extensions\\SynchronizationContextExtensions.cs" [[extensions]] name = "SendInContext" -sig = "void SendInContext(this SynchronizationContext context, object sender, Action action)" returns = "void" +sig = "void SendInContext(this SynchronizationContext context, object sender, Action action)" file = "Extensions\\SynchronizationContextExtensions.cs" [[extensions]] name = "PostInContext" -sig = "TaskCompletionSource PostInContext(this SynchronizationContext context, - Action action, - object sender, - Action handleException = null)" returns = "TaskCompletionSource" +sig = "TaskCompletionSource PostInContext(this SynchronizationContext context, Action action, object sender, Action handleException = null)" file = "Extensions\\SynchronizationContextExtensions.cs" [[classes]] @@ -138,8 +609,8 @@ static = true [[extensions]] name = "IsPlatformMainThread" -sig = "bool IsPlatformMainThread(this Thread currentThread, bool? isUIApp = null)" returns = "bool" +sig = "bool IsPlatformMainThread(this Thread currentThread, bool? isUIApp = null)" file = "Extensions\\ThreadExtensions.cs" [[classes]] @@ -148,29 +619,172 @@ ns = "FEx.Core.Abstractions.Extensions" file = "Extensions\\UriExtensions.cs" static = true +[[extensions]] +name = "IsUriReachableAsync" +returns = "Task<(bool, long)>" +sig = "Task<(bool, long)> IsUriReachableAsync(this string url, WebRequestParams pars = null)" +summary = "Determines whether the specified URL is reachable." +file = "Extensions\\UriExtensions.cs" + +[[extensions]] +name = "IsUriReachableAsync" +returns = "Task<(bool isAvailable, long loadTime)>" +sig = "Task<(bool isAvailable, long loadTime)> IsUriReachableAsync( this Uri url, WebRequestParams pars = null)" +summary = "Determines whether the specified URL is reachable." +file = "Extensions\\UriExtensions.cs" + +[[extensions]] +name = "GetHttpFileSizeAsync" +returns = "Task" +sig = "Task GetHttpFileSizeAsync(this Uri url, WebRequestParams pars = null, Stopwatch stopwatch = null)" +file = "Extensions\\UriExtensions.cs" + +[[extensions]] +name = "GetResponseHeadersAsync" +returns = "Task>" +sig = "Task> GetResponseHeadersAsync(this Uri url, WebRequestParams pars = null)" +file = "Extensions\\UriExtensions.cs" + +[[extensions]] +name = "DoHttpResponseFuncTaskAsync" +returns = "Task" +sig = "Task DoHttpResponseFuncTaskAsync(this Uri url, Func> func, WebRequestParams pars = null, Stopwatch stopwatch = null)" +file = "Extensions\\UriExtensions.cs" + +[[extensions]] +name = "DoHttpResponseFuncAsync" +returns = "Task" +sig = "Task DoHttpResponseFuncAsync(this Uri url, Func func, WebRequestParams pars = null, Stopwatch stopwatch = null)" +file = "Extensions\\UriExtensions.cs" + +[[extensions]] +name = "DoHttpResponseActionAsync" +returns = "Task" +sig = "Task DoHttpResponseActionAsync(this Uri url, Action action, WebRequestParams pars = null, Stopwatch stopwatch = null)" +file = "Extensions\\UriExtensions.cs" + +[[extensions]] +name = "DoHttpClientResponseFuncTaskAsync" +returns = "Task" +sig = "Task DoHttpClientResponseFuncTaskAsync(this Uri url, Func> func, WebRequestParams pars = null, Stopwatch stopwatch = null)" +file = "Extensions\\UriExtensions.cs" + +[[extensions]] +name = "DoHttpClientResponseFuncAsync" +returns = "Task" +sig = "Task DoHttpClientResponseFuncAsync(this Uri url, Func func, WebRequestParams pars = null, Stopwatch stopwatch = null)" +file = "Extensions\\UriExtensions.cs" + +[[extensions]] +name = "DoHttpClientResponseActionAsync" +returns = "Task" +sig = "Task DoHttpClientResponseActionAsync(this Uri url, Action action, WebRequestParams pars = null, Stopwatch stopwatch = null)" +file = "Extensions\\UriExtensions.cs" + +[[extensions]] +name = "CheckIfLinkIsExpiredAsync" +returns = "Task" +sig = "Task CheckIfLinkIsExpiredAsync(this Uri link, WebRequestParams pars = null)" +file = "Extensions\\UriExtensions.cs" + +[[extensions]] +name = "UrlIsValidAsync" +returns = "Task>" +sig = "Task> UrlIsValidAsync(this Uri url, WebRequestParams pars = null)" +file = "Extensions\\UriExtensions.cs" + [[classes]] name = "StackError" ns = "FEx.Core.Abstractions.Flow" base = "Error, IStackError" file = "Flow\\StackError.cs" -[[classes]] -name = "StackError" -ns = "FEx.Core.Abstractions.Flow" -base = "Error, IStackError" +[[properties]] +parent = "StackError" +name = "StackTrace" +sig = "string StackTrace { get; }" +returns = "string" file = "Flow\\StackError.cs" -[[classes]] -name = "ApiError" -ns = "FEx.Core.Abstractions.Flow.Errors" -base = "StackError" -file = "Flow\\Errors\\ApiError.cs" +[[properties]] +parent = "StackError" +name = "RootErrorStackTrace" +sig = "string RootErrorStackTrace { get; }" +returns = "string" +file = "Flow\\StackError.cs" + +[[properties]] +parent = "StackError" +name = "OriginalStackTrace" +sig = "StackTrace OriginalStackTrace { get; }" +returns = "StackTrace" +file = "Flow\\StackError.cs" + +[[ctors]] +parent = "StackError" +sig = "StackError()" +file = "Flow\\StackError.cs" + +[[ctors]] +parent = "StackError" +sig = "StackError(string message)" +file = "Flow\\StackError.cs" + +[[ctors]] +parent = "StackError" +sig = "StackError(IError innerError, string message = null)" +file = "Flow\\StackError.cs" + +[[methods]] +parent = "StackError" +name = "ToString" +sig = "string ToString()" +returns = "string" +file = "Flow\\StackError.cs" [[classes]] -name = "TimeoutError" -ns = "FEx.Core.Abstractions.Flow.Errors" -base = "Error" -file = "Flow\\Errors\\TimeoutError.cs" +name = "StackError" +ns = "FEx.Core.Abstractions.Flow" +base = "Error, IStackError" +file = "Flow\\StackError.cs" + +[[properties]] +parent = "StackError" +name = "StackTrace" +sig = "string StackTrace { get; }" +returns = "string" +file = "Flow\\StackError.cs" + +[[properties]] +parent = "StackError" +name = "RootErrorStackTrace" +sig = "string RootErrorStackTrace { get; }" +returns = "string" +file = "Flow\\StackError.cs" + +[[properties]] +parent = "StackError" +name = "OriginalStackTrace" +sig = "StackTrace OriginalStackTrace { get; }" +returns = "StackTrace" +file = "Flow\\StackError.cs" + +[[ctors]] +parent = "StackError" +sig = "StackError(TErrorStatus status, string message = null)" +file = "Flow\\StackError.cs" + +[[ctors]] +parent = "StackError" +sig = "StackError(TErrorStatus status, IError innerError, string message = null)" +file = "Flow\\StackError.cs" + +[[methods]] +parent = "StackError" +name = "ToString" +sig = "string ToString()" +returns = "string" +file = "Flow\\StackError.cs" [[classes]] name = "AsyncHelper" @@ -178,24 +792,181 @@ ns = "FEx.Core.Abstractions.Helpers" base = "IAsyncHelper" file = "Helpers\\AsyncHelper.cs" +[[ctors]] +parent = "AsyncHelper" +sig = "AsyncHelper(IFExDispatcher dispatcher, //ITasksInfoSubject tasksInfoSubject, IExceptionHandler exceptionHandler)" +file = "Helpers\\AsyncHelper.cs" + +[[methods]] +parent = "AsyncHelper" +name = "ExecuteDeferredTaskOnMainThreadAsync" +sig = "Task ExecuteDeferredTaskOnMainThreadAsync(Action func, AsyncOptions options = AsyncOptions.ImmediateStart)" +returns = "Task" +file = "Helpers\\AsyncHelper.cs" + +[[methods]] +parent = "AsyncHelper" +name = "ExecuteDeferredTaskOnMainThreadAsync" +sig = "Task ExecuteDeferredTaskOnMainThreadAsync(Func func, AsyncOptions options = AsyncOptions.ImmediateStart)" +returns = "Task" +file = "Helpers\\AsyncHelper.cs" + +[[methods]] +parent = "AsyncHelper" +name = "ExecuteDeferredTaskOnMainThreadAsync" +sig = "Task ExecuteDeferredTaskOnMainThreadAsync(Func func, AsyncOptions options = AsyncOptions.ImmediateStart)" +returns = "Task" +file = "Helpers\\AsyncHelper.cs" + +[[methods]] +parent = "AsyncHelper" +name = "ExecuteDeferredTaskOnMainThreadAsync" +sig = "Task ExecuteDeferredTaskOnMainThreadAsync(Func> func, AsyncOptions options = AsyncOptions.ImmediateStart)" +returns = "Task" +file = "Helpers\\AsyncHelper.cs" + +[[methods]] +parent = "AsyncHelper" +name = "FireAndForget" +sig = "ITaskWrapper FireAndForget(Action action, AsyncMode asyncMode, IExceptionHandlerOptions options, CancellationToken cancellationToken)" +returns = "ITaskWrapper" +file = "Helpers\\AsyncHelper.cs" + +[[methods]] +parent = "AsyncHelper" +name = "FireAndForget" +sig = "ITaskWrapper FireAndForget(Func func, AsyncMode asyncMode, IExceptionHandlerOptions options, CancellationToken cancellationToken)" +returns = "ITaskWrapper" +file = "Helpers\\AsyncHelper.cs" + +[[methods]] +parent = "AsyncHelper" +name = "FireTaskAndForget" +sig = "ITaskWrapper FireTaskAndForget(Func task, AsyncMode asyncMode = AsyncMode.Default, IExceptionHandlerOptions options = null)" +returns = "ITaskWrapper" +file = "Helpers\\AsyncHelper.cs" + +[[methods]] +parent = "AsyncHelper" +name = "FireTaskAndForget" +sig = "ITaskWrapper FireTaskAndForget(Func> task, AsyncMode asyncMode = AsyncMode.Default, IExceptionHandlerOptions options = null)" +returns = "ITaskWrapper" +file = "Helpers\\AsyncHelper.cs" + +[[methods]] +parent = "AsyncHelper" +name = "FireTasksAndForget" +sig = "IReadOnlyList FireTasksAndForget(IEnumerable> tasks, AsyncMode asyncMode = AsyncMode.Default, IExceptionHandlerOptions options = null)" +returns = "IReadOnlyList" +file = "Helpers\\AsyncHelper.cs" + +[[methods]] +parent = "AsyncHelper" +name = "FireTasksAndForget" +sig = "IReadOnlyList> FireTasksAndForget(IEnumerable>> tasks, AsyncMode asyncMode = AsyncMode.Default, IExceptionHandlerOptions options = null)" +returns = "IReadOnlyList>" +file = "Helpers\\AsyncHelper.cs" + +[[methods]] +parent = "AsyncHelper" +name = "FireAndForget" +sig = "ITaskWrapper FireAndForget(Action action)" +returns = "ITaskWrapper" +file = "Helpers\\AsyncHelper.cs" + +[[methods]] +parent = "AsyncHelper" +name = "FireAndForget" +sig = "ITaskWrapper FireAndForget(Action action, AsyncMode asyncMode)" +returns = "ITaskWrapper" +file = "Helpers\\AsyncHelper.cs" + +[[methods]] +parent = "AsyncHelper" +name = "FireAndForget" +sig = "ITaskWrapper FireAndForget(Func func)" +returns = "ITaskWrapper" +file = "Helpers\\AsyncHelper.cs" + +[[methods]] +parent = "AsyncHelper" +name = "FireAndForget" +sig = "ITaskWrapper FireAndForget(Func func, AsyncMode asyncMode)" +returns = "ITaskWrapper" +file = "Helpers\\AsyncHelper.cs" + [[classes]] name = "DeadlockMonitor" ns = "FEx.Core.Abstractions.Helpers" base = "IDeadlockMonitor" file = "Helpers\\DeadlockMonitor.cs" +[[ctors]] +parent = "DeadlockMonitor" +sig = "DeadlockMonitor(IStackTraceProvider stackTraceProvider, ILogger logger)" +file = "Helpers\\DeadlockMonitor.cs" + +[[methods]] +parent = "DeadlockMonitor" +name = "Execute" +sig = "void Execute(Action action, StackTrace stackTrace, uint timeout)" +returns = "void" +file = "Helpers\\DeadlockMonitor.cs" + [[classes]] name = "DebugExceptionHandler" ns = "FEx.Core.Abstractions.Helpers" base = "ExceptionHandlerBase" file = "Helpers\\DebugExceptionHandler.cs" +[[methods]] +parent = "DebugExceptionHandler" +name = "HandleException" +sig = "void HandleException(Exception exception, IExceptionHandlerOptions options)" +returns = "void" +file = "Helpers\\DebugExceptionHandler.cs" + [[classes]] name = "ExceptionHandlerBase" ns = "FEx.Core.Abstractions.Helpers" base = "IExceptionHandler" file = "Helpers\\ExceptionHandlerBase.cs" +[[properties]] +parent = "ExceptionHandlerBase" +name = "LastException" +sig = "Exception LastException { get; set; }" +returns = "Exception" +file = "Helpers\\ExceptionHandlerBase.cs" + +[[properties]] +parent = "ExceptionHandlerBase" +name = "Callback" +sig = "Func Callback { get; set; }" +returns = "Func" +file = "Helpers\\ExceptionHandlerBase.cs" + +[[properties]] +parent = "ExceptionHandlerBase" +name = "ConsolePresent" +sig = "bool ConsolePresent { get; }" +returns = "bool" +file = "Helpers\\ExceptionHandlerBase.cs" + +[[methods]] +parent = "ExceptionHandlerBase" +name = "Handle" +sig = "void Handle(Exception exception, IExceptionHandlerOptions options = null)" +returns = "void" +file = "Helpers\\ExceptionHandlerBase.cs" + +[[methods]] +parent = "ExceptionHandlerBase" +name = "HandleException" +sig = "void HandleException(Exception exception, IExceptionHandlerOptions options)" +returns = "void" +file = "Helpers\\ExceptionHandlerBase.cs" + [[classes]] name = "ReflectionHelper" ns = "FEx.Core.Abstractions.Helpers" @@ -204,48 +975,50 @@ static = true [[extensions]] name = "GetPropertyValue" -sig = "object GetPropertyValue(this object obj, string propertyName)" returns = "object" +sig = "object GetPropertyValue(this object obj, string propertyName)" file = "Helpers\\ReflectionHelper.cs" [[extensions]] name = "SetPropertyValue" -sig = "void SetPropertyValue(this object obj, string propertyName, object val)" returns = "void" +sig = "void SetPropertyValue(this object obj, string propertyName, object val)" file = "Helpers\\ReflectionHelper.cs" [[extensions]] name = "GetFieldValue" -sig = "object GetFieldValue(this object obj, string fieldName)" returns = "object" +sig = "object GetFieldValue(this object obj, string fieldName)" file = "Helpers\\ReflectionHelper.cs" [[extensions]] name = "HasResource" -sig = "bool HasResource(this Assembly assembly, - string resourceName, - bool throwIfMissing = true, - bool addNamespace = false)" returns = "bool" +sig = "bool HasResource(this Assembly assembly, string resourceName, bool throwIfMissing = true, bool addNamespace = false)" file = "Helpers\\ReflectionHelper.cs" [[extensions]] name = "ReadEmbeddedFile" -sig = "string ReadEmbeddedFile(this Assembly assembly, - string resourceName, - bool throwIfMissing = true, - bool addNamespace = false)" returns = "string" +sig = "string ReadEmbeddedFile(this Assembly assembly, string resourceName, bool throwIfMissing = true, bool addNamespace = false)" +file = "Helpers\\ReflectionHelper.cs" + +[[extensions]] +name = "GetEntryAssemblyAttribute" +returns = "string" +sig = "string GetEntryAssemblyAttribute(this Assembly assembly, Func func)" +file = "Helpers\\ReflectionHelper.cs" + +[[extensions]] +name = "ToObject" +returns = "T" +sig = "T ToObject(this IDictionary source)" file = "Helpers\\ReflectionHelper.cs" [[extensions]] name = "AsDictionary" -sig = "IDictionary AsDictionary(this object source, - BindingFlags bindingAttr = - BindingFlags.DeclaredOnly - | BindingFlags.Public - | BindingFlags.Instance)" returns = "IDictionary" +sig = "IDictionary AsDictionary(this object source, BindingFlags bindingAttr = BindingFlags.DeclaredOnly | BindingFlags.Public | BindingFlags.Instance)" file = "Helpers\\ReflectionHelper.cs" [[classes]] @@ -254,38 +1027,308 @@ ns = "FEx.Core.Abstractions.Helpers" base = "IStackTraceProvider" file = "Helpers\\StackTraceProvider.cs" +[[methods]] +parent = "StackTraceProvider" +name = "GetStackTrace" +sig = "StackTrace GetStackTrace()" +returns = "StackTrace" +file = "Helpers\\StackTraceProvider.cs" + [[classes]] name = "DefaultDispatcher" ns = "FEx.Core.Abstractions.Implementations" base = "FExDispatcher" file = "Implementations\\DefaultDispatcher.cs" +[[ctors]] +parent = "DefaultDispatcher" +sig = "DefaultDispatcher(ILogger logger, IMainThreadContextProvider mainThreadContextProvider, IDeadlockMonitor deadlockMonitor, IStackTraceProvider stackTraceProvider, IAppThreadingSettings appThreadingSettings)" +file = "Implementations\\DefaultDispatcher.cs" + +[[methods]] +parent = "DefaultDispatcher" +name = "CheckAccess" +sig = "bool CheckAccess(object sender = null)" +returns = "bool" +file = "Implementations\\DefaultDispatcher.cs" + +[[methods]] +parent = "DefaultDispatcher" +name = "BeginInvokeOnMainThread" +sig = "void BeginInvokeOnMainThread(Action action, object sender = null)" +returns = "void" +file = "Implementations\\DefaultDispatcher.cs" + +[[methods]] +parent = "DefaultDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func action, object sender = null)" +returns = "Task" +file = "Implementations\\DefaultDispatcher.cs" + +[[methods]] +parent = "DefaultDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Action action, object sender = null)" +returns = "Task" +file = "Implementations\\DefaultDispatcher.cs" + +[[methods]] +parent = "DefaultDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func> funcTask, object sender = null)" +returns = "Task" +file = "Implementations\\DefaultDispatcher.cs" + +[[methods]] +parent = "DefaultDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func funcTask, object sender = null)" +returns = "Task" +file = "Implementations\\DefaultDispatcher.cs" + +[[methods]] +parent = "DefaultDispatcher" +name = "EnableCollectionSynchronization" +sig = "void EnableCollectionSynchronization(IEnumerable collection, object context, Action callback)" +returns = "void" +file = "Implementations\\DefaultDispatcher.cs" + [[classes]] name = "DefaultStackTraceProvider" ns = "FEx.Core.Abstractions.Implementations" base = "IStackTraceProvider" file = "Implementations\\DefaultStackTraceProvider.cs" +[[methods]] +parent = "DefaultStackTraceProvider" +name = "GetStackTrace" +sig = "StackTrace GetStackTrace()" +returns = "StackTrace" +file = "Implementations\\DefaultStackTraceProvider.cs" + [[classes]] name = "ExceptionHandlerOptions" ns = "FEx.Core.Abstractions.Implementations" base = "IExceptionHandlerOptions" file = "Implementations\\ExceptionHandlerOptions.cs" +[[properties]] +parent = "ExceptionHandlerOptions" +name = "InformUser" +sig = "bool InformUser { get; set; }" +returns = "bool" +file = "Implementations\\ExceptionHandlerOptions.cs" + +[[properties]] +parent = "ExceptionHandlerOptions" +name = "Wait" +sig = "bool Wait { get; set; }" +returns = "bool" +file = "Implementations\\ExceptionHandlerOptions.cs" + +[[properties]] +parent = "ExceptionHandlerOptions" +name = "DoNotReport" +sig = "bool DoNotReport { get; set; }" +returns = "bool" +file = "Implementations\\ExceptionHandlerOptions.cs" + +[[properties]] +parent = "ExceptionHandlerOptions" +name = "Custom" +sig = "IDictionary Custom { get; set; }" +returns = "IDictionary" +file = "Implementations\\ExceptionHandlerOptions.cs" + [[classes]] name = "FExDispatcher" ns = "FEx.Core.Abstractions.Implementations" base = "IFExDispatcher" file = "Implementations\\FExDispatcher.cs" +[[properties]] +parent = "FExDispatcher" +name = "MainThreadSynchronizationContext" +sig = "SynchronizationContext MainThreadSynchronizationContext { get; }" +returns = "SynchronizationContext" +file = "Implementations\\FExDispatcher.cs" + +[[ctors]] +parent = "FExDispatcher" +sig = "FExDispatcher(ILogger logger, IMainThreadContextProvider mainThreadContextProvider, IDeadlockMonitor deadlockMonitor, IStackTraceProvider stackTraceProvider, bool isDeadlockMonitoringEnabled = false)" +file = "Implementations\\FExDispatcher.cs" + +[[methods]] +parent = "FExDispatcher" +name = "CheckAccess" +sig = "bool CheckAccess(object sender = null)" +returns = "bool" +file = "Implementations\\FExDispatcher.cs" + +[[methods]] +parent = "FExDispatcher" +name = "BeginInvokeOnMainThread" +sig = "void BeginInvokeOnMainThread(Action action, object sender = null)" +returns = "void" +file = "Implementations\\FExDispatcher.cs" + +[[methods]] +parent = "FExDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Action action, object sender = null)" +returns = "Task" +file = "Implementations\\FExDispatcher.cs" + +[[methods]] +parent = "FExDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func action, object sender = null)" +returns = "Task" +file = "Implementations\\FExDispatcher.cs" + +[[methods]] +parent = "FExDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func> funcTask, object sender = null)" +returns = "Task" +file = "Implementations\\FExDispatcher.cs" + +[[methods]] +parent = "FExDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func funcTask, object sender = null)" +returns = "Task" +file = "Implementations\\FExDispatcher.cs" + +[[methods]] +parent = "FExDispatcher" +name = "InvokeOnIdleMainThread" +sig = "void InvokeOnIdleMainThread(Action action, object sender = null)" +returns = "void" +file = "Implementations\\FExDispatcher.cs" + +[[methods]] +parent = "FExDispatcher" +name = "InvokeOnIdleMainThread" +sig = "T InvokeOnIdleMainThread(Func action, object sender = null)" +returns = "T" +file = "Implementations\\FExDispatcher.cs" + +[[methods]] +parent = "FExDispatcher" +name = "InvokeOnIdleMainThreadAsync" +sig = "Task InvokeOnIdleMainThreadAsync(Func action, object sender = null)" +returns = "Task" +file = "Implementations\\FExDispatcher.cs" + +[[methods]] +parent = "FExDispatcher" +name = "InvokeOnIdleMainThreadAsync" +sig = "Task InvokeOnIdleMainThreadAsync(Action action, object sender = null)" +returns = "Task" +file = "Implementations\\FExDispatcher.cs" + +[[methods]] +parent = "FExDispatcher" +name = "InvokeOnMainThread" +sig = "void InvokeOnMainThread(Action action, object sender = null)" +returns = "void" +file = "Implementations\\FExDispatcher.cs" + +[[methods]] +parent = "FExDispatcher" +name = "InvokeOnMainThread" +sig = "T InvokeOnMainThread(Func action, object sender = null)" +returns = "T" +file = "Implementations\\FExDispatcher.cs" + +[[methods]] +parent = "FExDispatcher" +name = "EnableCollectionSynchronization" +sig = "void EnableCollectionSynchronization(IEnumerable collection, object context, Action callback)" +returns = "void" +file = "Implementations\\FExDispatcher.cs" + +[[methods]] +parent = "FExDispatcher" +name = "SendInContext" +sig = "void SendInContext(Action action, object sender, uint? timeout)" +returns = "void" +file = "Implementations\\FExDispatcher.cs" + [[interfaces]] name = "IAppThreadingSettings" ns = "FEx.Core.Abstractions.Interfaces" file = "Interfaces\\IAppThreadingSettings.cs" +[[properties]] +parent = "IAppThreadingSettings" +name = "IsDeadlockMonitoringEnabled" +sig = "bool IsDeadlockMonitoringEnabled { get; }" +returns = "bool" +file = "Interfaces\\IAppThreadingSettings.cs" + [[interfaces]] name = "IAsyncInitializable" ns = "FEx.Core.Abstractions.Interfaces" +base = "IDisposable, INotifyPropertyChanged" +file = "Interfaces\\IAsyncInitializable.cs" + +[[properties]] +parent = "IAsyncInitializable" +name = "IsInitialized" +sig = "bool IsInitialized { get; }" +returns = "bool" +file = "Interfaces\\IAsyncInitializable.cs" + +[[properties]] +parent = "IAsyncInitializable" +name = "TypeName" +sig = "string TypeName { get; }" +returns = "string" +file = "Interfaces\\IAsyncInitializable.cs" + +[[properties]] +parent = "IAsyncInitializable" +name = "TypeFullName" +sig = "string TypeFullName { get; }" +returns = "string" +file = "Interfaces\\IAsyncInitializable.cs" + +[[properties]] +parent = "IAsyncInitializable" +name = "HasFinishedInitialization" +sig = "bool HasFinishedInitialization { get; }" +returns = "bool" +file = "Interfaces\\IAsyncInitializable.cs" + +[[properties]] +parent = "IAsyncInitializable" +name = "IsInitializing" +sig = "bool IsInitializing { get; }" +returns = "bool" +file = "Interfaces\\IAsyncInitializable.cs" + +[[methods]] +parent = "IAsyncInitializable" +name = "InitializeAsync" +sig = "Task InitializeAsync()" +returns = "Task" +file = "Interfaces\\IAsyncInitializable.cs" + +[[methods]] +parent = "IAsyncInitializable" +name = "BeginInitialization" +sig = "void BeginInitialization(bool waitSynchronouslyForInitialization = false)" +returns = "void" +file = "Interfaces\\IAsyncInitializable.cs" + +[[methods]] +parent = "IAsyncInitializable" +name = "Reset" +sig = "void Reset()" +returns = "void" file = "Interfaces\\IAsyncInitializable.cs" [[interfaces]] @@ -293,19 +1336,65 @@ name = "IDeadlockMonitor" ns = "FEx.Core.Abstractions.Interfaces" file = "Interfaces\\IDeadlockMonitor.cs" +[[methods]] +parent = "IDeadlockMonitor" +name = "Execute" +sig = "void Execute(Action action, StackTrace stackTrace, uint timeout)" +returns = "void" +file = "Interfaces\\IDeadlockMonitor.cs" + [[interfaces]] name = "IExceptionHandler" ns = "FEx.Core.Abstractions.Interfaces" file = "Interfaces\\IExceptionHandler.cs" +[[properties]] +parent = "IExceptionHandler" +name = "LastException" +sig = "Exception LastException { get; set; }" +returns = "Exception" +summary = "The last exception" +file = "Interfaces\\IExceptionHandler.cs" + +[[properties]] +parent = "IExceptionHandler" +name = "Callback" +sig = "Func Callback { get; set; }" +returns = "Func" +file = "Interfaces\\IExceptionHandler.cs" + +[[properties]] +parent = "IExceptionHandler" +name = "ConsolePresent" +sig = "bool ConsolePresent { get; }" +returns = "bool" +file = "Interfaces\\IExceptionHandler.cs" + +[[methods]] +parent = "IExceptionHandler" +name = "Handle" +sig = "void Handle(Exception exception, IExceptionHandlerOptions options = null)" +returns = "void" +file = "Interfaces\\IExceptionHandler.cs" + [[interfaces]] name = "IFExBehaviorSubject" ns = "FEx.Core.Abstractions.Interfaces" +base = "IFExSubject" +file = "Interfaces\\IFExBehaviorSubject.cs" + +[[properties]] +parent = "IFExBehaviorSubject" +name = "Value" +sig = "T Value { get; }" +returns = "T" +summary = "Gets the current value or throws an exception." file = "Interfaces\\IFExBehaviorSubject.cs" [[interfaces]] name = "IFExCoreContainer" ns = "FEx.Core.Abstractions.Interfaces" +base = "IContainer, IContainer, IContainer, IContainer, IContainer, IContainer, IContainer, IContainer, IContainer, IContainer, IContainer" file = "Interfaces\\IFExCoreContainer.cs" [[interfaces]] @@ -313,9 +1402,122 @@ name = "IFExDispatcher" ns = "FEx.Core.Abstractions.Interfaces" file = "Interfaces\\IFExDispatcher.cs" +[[methods]] +parent = "IFExDispatcher" +name = "CheckAccess" +sig = "bool CheckAccess(object sender = null)" +returns = "bool" +file = "Interfaces\\IFExDispatcher.cs" + +[[methods]] +parent = "IFExDispatcher" +name = "BeginInvokeOnMainThread" +sig = "void BeginInvokeOnMainThread(Action action, object sender = null)" +returns = "void" +file = "Interfaces\\IFExDispatcher.cs" + +[[methods]] +parent = "IFExDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Action action, object sender = null)" +returns = "Task" +file = "Interfaces\\IFExDispatcher.cs" + +[[methods]] +parent = "IFExDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func action, object sender = null)" +returns = "Task" +file = "Interfaces\\IFExDispatcher.cs" + +[[methods]] +parent = "IFExDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func> funcTask, object sender = null)" +returns = "Task" +file = "Interfaces\\IFExDispatcher.cs" + +[[methods]] +parent = "IFExDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func funcTask, object sender = null)" +returns = "Task" +file = "Interfaces\\IFExDispatcher.cs" + +[[methods]] +parent = "IFExDispatcher" +name = "InvokeOnIdleMainThread" +sig = "void InvokeOnIdleMainThread(Action action, object sender = null)" +returns = "void" +file = "Interfaces\\IFExDispatcher.cs" + +[[methods]] +parent = "IFExDispatcher" +name = "InvokeOnIdleMainThread" +sig = "T InvokeOnIdleMainThread(Func action, object sender = null)" +returns = "T" +file = "Interfaces\\IFExDispatcher.cs" + +[[methods]] +parent = "IFExDispatcher" +name = "InvokeOnIdleMainThreadAsync" +sig = "Task InvokeOnIdleMainThreadAsync(Func action, object sender = null)" +returns = "Task" +file = "Interfaces\\IFExDispatcher.cs" + +[[methods]] +parent = "IFExDispatcher" +name = "InvokeOnIdleMainThreadAsync" +sig = "Task InvokeOnIdleMainThreadAsync(Action action, object sender = null)" +returns = "Task" +file = "Interfaces\\IFExDispatcher.cs" + +[[methods]] +parent = "IFExDispatcher" +name = "InvokeOnMainThread" +sig = "void InvokeOnMainThread(Action action, object sender = null)" +returns = "void" +file = "Interfaces\\IFExDispatcher.cs" + +[[methods]] +parent = "IFExDispatcher" +name = "InvokeOnMainThread" +sig = "T InvokeOnMainThread(Func action, object sender = null)" +returns = "T" +file = "Interfaces\\IFExDispatcher.cs" + +[[methods]] +parent = "IFExDispatcher" +name = "EnableCollectionSynchronization" +sig = "void EnableCollectionSynchronization(IEnumerable collection, object context, Action callback)" +returns = "void" +file = "Interfaces\\IFExDispatcher.cs" + +[[methods]] +parent = "IFExDispatcher" +name = "SendInContext" +sig = "void SendInContext(Action action, object sender, uint? timeout)" +returns = "void" +file = "Interfaces\\IFExDispatcher.cs" + [[interfaces]] name = "IFExSubject" ns = "FEx.Core.Abstractions.Interfaces" +base = "IDisposable, IObservable" +file = "Interfaces\\IFExSubject.cs" + +[[methods]] +parent = "IFExSubject" +name = "OnNext" +sig = "void OnNext(T value)" +returns = "void" +file = "Interfaces\\IFExSubject.cs" + +[[methods]] +parent = "IFExSubject" +name = "OnCompleted" +sig = "void OnCompleted()" +returns = "void" file = "Interfaces\\IFExSubject.cs" [[interfaces]] @@ -323,9 +1525,59 @@ name = "IMainThreadContextProvider" ns = "FEx.Core.Abstractions.Interfaces" file = "Interfaces\\IMainThreadContextProvider.cs" +[[properties]] +parent = "IMainThreadContextProvider" +name = "Thread" +sig = "Thread Thread { get; }" +returns = "Thread" +file = "Interfaces\\IMainThreadContextProvider.cs" + +[[properties]] +parent = "IMainThreadContextProvider" +name = "IsDispatcherContext" +sig = "bool IsDispatcherContext { get; set; }" +returns = "bool" +file = "Interfaces\\IMainThreadContextProvider.cs" + +[[properties]] +parent = "IMainThreadContextProvider" +name = "Context" +sig = "SynchronizationContext Context { get; }" +returns = "SynchronizationContext" +file = "Interfaces\\IMainThreadContextProvider.cs" + +[[methods]] +parent = "IMainThreadContextProvider" +name = "SetMainThread" +sig = "void SetMainThread(bool throwOnNonMainThread = true)" +returns = "void" +file = "Interfaces\\IMainThreadContextProvider.cs" + [[interfaces]] name = "INavigationFlowSubject" ns = "FEx.Core.Abstractions.Interfaces" +base = "IFExBehaviorSubject>" +file = "Interfaces\\INavigationFlowSubject.cs" + +[[methods]] +parent = "INavigationFlowSubject" +name = "OnNext" +sig = "void OnNext(NavigationFlowChange value)" +returns = "void" +file = "Interfaces\\INavigationFlowSubject.cs" + +[[methods]] +parent = "INavigationFlowSubject" +name = "Pop" +sig = "void Pop(Type pageType)" +returns = "void" +file = "Interfaces\\INavigationFlowSubject.cs" + +[[methods]] +parent = "INavigationFlowSubject" +name = "Push" +sig = "void Push(Type pageType)" +returns = "void" file = "Interfaces\\INavigationFlowSubject.cs" [[interfaces]] @@ -333,68 +1585,591 @@ name = "IResxManager" ns = "FEx.Core.Abstractions.Interfaces" file = "Interfaces\\IResxManager.cs" +[[methods]] +parent = "IResxManager" +name = "UpdateResourceFile" +sig = "void UpdateResourceFile(List> data, string path)" +returns = "void" +file = "Interfaces\\IResxManager.cs" + +[[methods]] +parent = "IResxManager" +name = "Resgen" +sig = "string[] Resgen(string resx, string resxDesigner, string fileName, string projectNamespace)" +returns = "string[]" +file = "Interfaces\\IResxManager.cs" + +[[methods]] +parent = "IResxManager" +name = "GetResourcesEntries" +sig = "Dictionary GetResourcesEntries(string path)" +returns = "Dictionary" +file = "Interfaces\\IResxManager.cs" + [[interfaces]] name = "IStackTraceProvider" ns = "FEx.Core.Abstractions.Interfaces" file = "Interfaces\\IStackTraceProvider.cs" +[[methods]] +parent = "IStackTraceProvider" +name = "GetStackTrace" +sig = "StackTrace GetStackTrace()" +returns = "StackTrace" +file = "Interfaces\\IStackTraceProvider.cs" + [[interfaces]] name = "ITasksInfoSubject" ns = "FEx.Core.Abstractions.Interfaces" file = "Interfaces\\ITasksInfoSubject.cs" +[[methods]] +parent = "ITasksInfoSubject" +name = "AddTask" +sig = "void AddTask(ITaskWrapperBase value)" +returns = "void" +file = "Interfaces\\ITasksInfoSubject.cs" + +[[methods]] +parent = "ITasksInfoSubject" +name = "AddTask" +sig = "void AddTask(Guid taskId)" +returns = "void" +file = "Interfaces\\ITasksInfoSubject.cs" + +[[methods]] +parent = "ITasksInfoSubject" +name = "RemoveTask" +sig = "void RemoveTask(ITaskWrapperBase value)" +returns = "void" +file = "Interfaces\\ITasksInfoSubject.cs" + +[[methods]] +parent = "ITasksInfoSubject" +name = "RemoveTask" +sig = "void RemoveTask(Guid taskId)" +returns = "void" +file = "Interfaces\\ITasksInfoSubject.cs" + +[[classes]] +name = "AppInfo" +ns = "FEx.Core.Abstractions.Models" +base = "IAppInfo" +file = "Models\\AppInfo.cs" + +[[properties]] +parent = "AppInfo" +name = "Name" +sig = "string Name { get; init; }" +returns = "string" +file = "Models\\AppInfo.cs" + +[[properties]] +parent = "AppInfo" +name = "Version" +sig = "Version Version { get; init; }" +returns = "Version" +file = "Models\\AppInfo.cs" + +[[properties]] +parent = "AppInfo" +name = "Company" +sig = "string Company { get; init; }" +returns = "string" +file = "Models\\AppInfo.cs" + +[[properties]] +parent = "AppInfo" +name = "IsUIApp" +sig = "bool IsUIApp { get; set; }" +returns = "bool" +file = "Models\\AppInfo.cs" + +[[properties]] +parent = "AppInfo" +name = "UserData" +sig = "DirectoryInfo UserData { get; init; }" +returns = "DirectoryInfo" +file = "Models\\AppInfo.cs" + +[[properties]] +parent = "AppInfo" +name = "AppData" +sig = "DirectoryInfo AppData { get; init; }" +returns = "DirectoryInfo" +file = "Models\\AppInfo.cs" + +[[properties]] +parent = "AppInfo" +name = "LogDirPath" +sig = "string LogDirPath { get; init; }" +returns = "string" +file = "Models\\AppInfo.cs" + +[[classes]] +name = "NavigationFlowChange" +ns = "FEx.Core.Abstractions.Models" +file = "Models\\NavigationFlowChange.cs" + +[[properties]] +parent = "NavigationFlowChange" +name = "SenderType" +sig = "string SenderType { get; }" +returns = "string" +file = "Models\\NavigationFlowChange.cs" + +[[properties]] +parent = "NavigationFlowChange" +name = "SenderName" +sig = "string SenderName { get; }" +returns = "string" +file = "Models\\NavigationFlowChange.cs" + +[[properties]] +parent = "NavigationFlowChange" +name = "Flow" +sig = "NavigationFlow Flow { get; }" +returns = "NavigationFlow" +file = "Models\\NavigationFlowChange.cs" + +[[ctors]] +parent = "NavigationFlowChange" +sig = "NavigationFlowChange(Type senderType, NavigationFlow flow)" +file = "Models\\NavigationFlowChange.cs" + [[classes]] name = "MainThreadContextProvider" ns = "FEx.Core.Abstractions.Providers" base = "IMainThreadContextProvider" file = "Providers\\MainThreadContextProvider.cs" +[[properties]] +parent = "MainThreadContextProvider" +name = "Thread" +sig = "Thread Thread { get; }" +returns = "Thread" +file = "Providers\\MainThreadContextProvider.cs" + +[[properties]] +parent = "MainThreadContextProvider" +name = "IsDispatcherContext" +sig = "bool IsDispatcherContext { get; set; }" +returns = "bool" +file = "Providers\\MainThreadContextProvider.cs" + +[[properties]] +parent = "MainThreadContextProvider" +name = "Context" +sig = "SynchronizationContext Context { get; }" +returns = "SynchronizationContext" +file = "Providers\\MainThreadContextProvider.cs" + +[[properties]] +parent = "MainThreadContextProvider" +name = "IsUIApp" +sig = "bool IsUIApp { get; }" +returns = "bool" +file = "Providers\\MainThreadContextProvider.cs" + +[[ctors]] +parent = "MainThreadContextProvider" +sig = "MainThreadContextProvider(IAppInfoProvider appInfoProvider)" +file = "Providers\\MainThreadContextProvider.cs" + +[[methods]] +parent = "MainThreadContextProvider" +name = "SetMainThread" +sig = "void SetMainThread(bool throwOnNonMainThread = true)" +returns = "void" +file = "Providers\\MainThreadContextProvider.cs" + [[classes]] name = "SynchronizedAccessService" ns = "FEx.Core.Abstractions.Services" base = "ISynchronizedAccessService, IDisposable" file = "Services\\SynchronizedAccessService.cs" +[[ctors]] +parent = "SynchronizedAccessService" +sig = "SynchronizedAccessService()" +file = "Services\\SynchronizedAccessService.cs" + +[[methods]] +parent = "SynchronizedAccessService" +name = "EnsureLock" +sig = "SemaphoreSlim EnsureLock(string key, int maxParallel = 1)" +returns = "SemaphoreSlim" +file = "Services\\SynchronizedAccessService.cs" + +[[methods]] +parent = "SynchronizedAccessService" +name = "RunLocked" +sig = "void RunLocked(Action action, string key, CancellationToken cancellationToken = default)" +returns = "void" +file = "Services\\SynchronizedAccessService.cs" + +[[methods]] +parent = "SynchronizedAccessService" +name = "RunLocked" +sig = "T RunLocked(Func action, string key, CancellationToken cancellationToken = default)" +returns = "T" +file = "Services\\SynchronizedAccessService.cs" + +[[methods]] +parent = "SynchronizedAccessService" +name = "RunLockedAsync" +sig = "Task RunLockedAsync(Action action, string key, CancellationToken cancellationToken = default)" +returns = "Task" +file = "Services\\SynchronizedAccessService.cs" + +[[methods]] +parent = "SynchronizedAccessService" +name = "RunLockedAsync" +sig = "Task RunLockedAsync(Func action, string key, CancellationToken cancellationToken = default)" +returns = "Task" +file = "Services\\SynchronizedAccessService.cs" + +[[methods]] +parent = "SynchronizedAccessService" +name = "Release" +sig = "void Release(string key)" +returns = "void" +file = "Services\\SynchronizedAccessService.cs" + +[[methods]] +parent = "SynchronizedAccessService" +name = "WaitAsync" +sig = "Task WaitAsync(string key, int maxParallel = 1, CancellationToken cancellationToken = default)" +returns = "Task" +file = "Services\\SynchronizedAccessService.cs" + +[[methods]] +parent = "SynchronizedAccessService" +name = "Wait" +sig = "void Wait(string key, int maxParallel = 1, CancellationToken cancellationToken = default)" +returns = "void" +file = "Services\\SynchronizedAccessService.cs" + +[[methods]] +parent = "SynchronizedAccessService" +name = "RemoveLock" +sig = "void RemoveLock(string key)" +returns = "void" +file = "Services\\SynchronizedAccessService.cs" + +[[methods]] +parent = "SynchronizedAccessService" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Services\\SynchronizedAccessService.cs" + [[classes]] name = "AppThreadingSettings" ns = "FEx.Core.Abstractions.Settings" base = "IAppThreadingSettings" file = "Settings\\AppThreadingSettings.cs" +[[properties]] +parent = "AppThreadingSettings" +name = "IsDeadlockMonitoringEnabled" +sig = "bool IsDeadlockMonitoringEnabled { get; set; }" +returns = "bool" +file = "Settings\\AppThreadingSettings.cs" + [[classes]] name = "FExBehaviorSubject" ns = "FEx.Core.Abstractions.Subjects" base = "FExSubject, IFExBehaviorSubject" file = "Subjects\\FExBehaviorSubject.cs" +[[properties]] +parent = "FExBehaviorSubject" +name = "Value" +sig = "T Value { get; }" +returns = "T" +summary = "Gets the current value or throws an exception." +file = "Subjects\\FExBehaviorSubject.cs" + +[[ctors]] +parent = "FExBehaviorSubject" +sig = "FExBehaviorSubject()" +file = "Subjects\\FExBehaviorSubject.cs" + +[[ctors]] +parent = "FExBehaviorSubject" +sig = "FExBehaviorSubject(T defaultValue)" +file = "Subjects\\FExBehaviorSubject.cs" + +[[methods]] +parent = "FExBehaviorSubject" +name = "ValueIsEqualTo" +sig = "bool ValueIsEqualTo(T value)" +returns = "bool" +file = "Subjects\\FExBehaviorSubject.cs" + [[classes]] name = "FExSubject" ns = "FEx.Core.Abstractions.Subjects" base = "IFExSubject" file = "Subjects\\FExSubject.cs" +[[ctors]] +parent = "FExSubject" +sig = "FExSubject()" +file = "Subjects\\FExSubject.cs" + +[[ctors]] +parent = "FExSubject" +sig = "FExSubject(ISubject subject)" +file = "Subjects\\FExSubject.cs" + +[[methods]] +parent = "FExSubject" +name = "OnNext" +sig = "void OnNext(T value)" +returns = "void" +file = "Subjects\\FExSubject.cs" + +[[methods]] +parent = "FExSubject" +name = "OnCompleted" +sig = "void OnCompleted()" +returns = "void" +file = "Subjects\\FExSubject.cs" + +[[methods]] +parent = "FExSubject" +name = "Subscribe" +sig = "IDisposable Subscribe(IObserver observer)" +returns = "IDisposable" +summary = "Notifies the provider that an observer is to receive notifications." +file = "Subjects\\FExSubject.cs" + +[[methods]] +parent = "FExSubject" +name = "SynchronizedOnNext" +sig = "void SynchronizedOnNext(T value)" +returns = "void" +file = "Subjects\\FExSubject.cs" + +[[methods]] +parent = "FExSubject" +name = "SynchronizedOnCompleted" +sig = "void SynchronizedOnCompleted()" +returns = "void" +file = "Subjects\\FExSubject.cs" + +[[methods]] +parent = "FExSubject" +name = "Dispose" +sig = "void Dispose(bool isDisposing)" +returns = "void" +file = "Subjects\\FExSubject.cs" + +[[methods]] +parent = "FExSubject" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Subjects\\FExSubject.cs" + [[classes]] name = "AppUtility" ns = "FEx.Core.Abstractions.Utilities" file = "Utilities\\AppUtility.cs" static = true +[[methods]] +parent = "AppUtility" +name = "IsSingleInstance" +sig = "static bool IsSingleInstance()" +returns = "bool" +file = "Utilities\\AppUtility.cs" +static = true + +[[methods]] +parent = "AppUtility" +name = "GetOtherInstances" +sig = "static int[] GetOtherInstances()" +returns = "int[]" +file = "Utilities\\AppUtility.cs" +static = true + [[classes]] name = "TaskWrapper" ns = "FEx.Core.Abstractions.Utilities" base = "TaskWrapperBase>, ITaskWrapper" file = "Utilities\\TaskWrapper.cs" +[[ctors]] +parent = "TaskWrapper" +sig = "TaskWrapper(Func task = null, bool setStackTrace = true)" +file = "Utilities\\TaskWrapper.cs" + +[[methods]] +parent = "TaskWrapper" +name = "SetResult" +sig = "void SetResult()" +returns = "void" +file = "Utilities\\TaskWrapper.cs" + +[[methods]] +parent = "TaskWrapper" +name = "ConvertExceptionToError" +sig = "Result ConvertExceptionToError(Exception exception)" +returns = "Result" +file = "Utilities\\TaskWrapper.cs" + +[[methods]] +parent = "TaskWrapper" +name = "ExecuteTaskAsync" +sig = "Task ExecuteTaskAsync(Func task)" +returns = "Task" +file = "Utilities\\TaskWrapper.cs" + [[classes]] name = "TaskWrapper" ns = "FEx.Core.Abstractions.Utilities" base = "TaskWrapperBase, Result>, ITaskWrapper" file = "Utilities\\TaskWrapper.cs" +[[ctors]] +parent = "TaskWrapper" +sig = "TaskWrapper(Func> task = null, bool setStackTrace = true)" +file = "Utilities\\TaskWrapper.cs" + +[[methods]] +parent = "TaskWrapper" +name = "SetResult" +sig = "void SetResult(T result)" +returns = "void" +file = "Utilities\\TaskWrapper.cs" + +[[methods]] +parent = "TaskWrapper" +name = "ConvertExceptionToError" +sig = "Result ConvertExceptionToError(Exception exception)" +returns = "Result" +file = "Utilities\\TaskWrapper.cs" + +[[methods]] +parent = "TaskWrapper" +name = "ExecuteTaskAsync" +sig = "Task ExecuteTaskAsync(Func> task)" +returns = "Task" +file = "Utilities\\TaskWrapper.cs" + [[classes]] name = "TaskWrapperBase" ns = "FEx.Core.Abstractions.Utilities" -base = "ITaskWrapperBase where TTask : Task - where TResult : class, IResult" +base = "ITaskWrapperBase" +file = "Utilities\\TaskWrapperBase.cs" + +[[properties]] +parent = "TaskWrapperBase" +name = "Id" +sig = "Guid Id { get; }" +returns = "Guid" file = "Utilities\\TaskWrapperBase.cs" +[[properties]] +parent = "TaskWrapperBase" +name = "IsFinished" +sig = "bool IsFinished { get; set; }" +returns = "bool" +file = "Utilities\\TaskWrapperBase.cs" + +[[properties]] +parent = "TaskWrapperBase" +name = "TaskCreationStackTrace" +sig = "StackTrace TaskCreationStackTrace { get; }" +returns = "StackTrace" +file = "Utilities\\TaskWrapperBase.cs" + +[[properties]] +parent = "TaskWrapperBase" +name = "Result" +sig = "TResult Result { get; set; }" +returns = "TResult" +file = "Utilities\\TaskWrapperBase.cs" + +[[properties]] +parent = "TaskWrapperBase" +name = "Task" +sig = "TTask Task { get; }" +returns = "TTask" +file = "Utilities\\TaskWrapperBase.cs" + +[[ctors]] +parent = "TaskWrapperBase" +sig = "TaskWrapperBase(Func task = null, bool setStackTrace = true)" +file = "Utilities\\TaskWrapperBase.cs" + +[[methods]] +parent = "TaskWrapperBase" +name = "SetException" +sig = "void SetException(Exception exception)" +returns = "void" +file = "Utilities\\TaskWrapperBase.cs" + +[[methods]] +parent = "TaskWrapperBase" +name = "SetTask" +sig = "void SetTask(Func task)" +returns = "void" +file = "Utilities\\TaskWrapperBase.cs" + +[[methods]] +parent = "TaskWrapperBase" +name = "ConvertExceptionToError" +sig = "TResult ConvertExceptionToError(Exception exception)" +returns = "TResult" +file = "Utilities\\TaskWrapperBase.cs" + +[[methods]] +parent = "TaskWrapperBase" +name = "ExecuteTaskAsync" +sig = "TTask ExecuteTaskAsync(Func task)" +returns = "TTask" +file = "Utilities\\TaskWrapperBase.cs" + +[[classes]] +name = "ApiError" +ns = "FEx.Core.Abstractions.Flow.Errors" +base = "StackError" +file = "Flow\\Errors\\ApiError.cs" + +[[properties]] +parent = "ApiError" +name = "RequestUrl" +sig = "string RequestUrl { get; }" +returns = "string" +file = "Flow\\Errors\\ApiError.cs" + +[[ctors]] +parent = "ApiError" +sig = "ApiError()" +file = "Flow\\Errors\\ApiError.cs" + +[[ctors]] +parent = "ApiError" +sig = "ApiError(string requestUrl = null, HttpStatusCode? status = null)" +file = "Flow\\Errors\\ApiError.cs" + +[[ctors]] +parent = "ApiError" +sig = "ApiError(string requestUrl, HttpStatusCode? status, string message = null)" +file = "Flow\\Errors\\ApiError.cs" + +[[ctors]] +parent = "ApiError" +sig = "ApiError(string requestUrl, HttpStatusCode? status, Error innerError, string message = null)" +file = "Flow\\Errors\\ApiError.cs" + +[[classes]] +name = "TimeoutError" +ns = "FEx.Core.Abstractions.Flow.Errors" +base = "Error" +file = "Flow\\Errors\\TimeoutError.cs" + diff --git a/.api-surface/FEx/Core.toml b/.api-surface/FEx/Core.toml index 54d5ec0a..08e1e6e3 100644 --- a/.api-surface/FEx/Core.toml +++ b/.api-surface/FEx/Core.toml @@ -8,40 +8,12 @@ ns = "FEx.Core" base = "InitializeModule" file = "FExCoreModule.cs" -[[classes]] -name = "IsExternalInit" -ns = "System.Runtime.CompilerServices" -file = "IsExternalInit.cs" -static = true - -[[classes]] -name = "ConcurrentHashSet" -ns = "FEx.Core.Collections.Concurrent" -base = "ISet, IReadOnlyCollection, IDisposable -#pragma warning restore IDISP025" -summary = "Thread-safe HashSet using composition with ReaderWriterLockSlim. https://stackoverflow.com/questions/18922985/concurrent-hashsett-in-net-framework" -file = "Collections\\Concurrent\\ConcurrentHashSet.cs" - -[[classes]] -name = "ConcurrentObservableDictionary" -ns = "FEx.Core.Collections.Concurrent" -base = "BaseConcurrentList>, - IDictionary, IDictionary, IReadOnlyDictionary, INotifyCollectionChanged, - INotifyPropertyChanged" -summary = "Based on https://github.com/ChadBurggraf/parallel-extensions-extras" -file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" - -[[classes]] -name = "ConcurrentObservableList" -ns = "FEx.Core.Collections.Concurrent" -base = "ConcurrentList, IObservableCollection" -file = "Collections\\Concurrent\\ConcurrentObservableList.cs" - -[[classes]] -name = "ConcurrentSortableObservableList" -ns = "FEx.Core.Collections.Concurrent" -base = "ConcurrentObservableList where T : IComparable" -file = "Collections\\Concurrent\\ConcurrentSortableObservableList.cs" +[[methods]] +parent = "FExCoreModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExCoreContainer container, IServiceCollection services)" +returns = "void" +file = "FExCoreModule.cs" [[classes]] name = "DateTimeExtensions" @@ -51,8 +23,8 @@ static = true [[extensions]] name = "ConvertWindowsToIanaTimeZone" -sig = "TimeZoneInfo ConvertWindowsToIanaTimeZone(this string timeZoneToId)" returns = "TimeZoneInfo" +sig = "TimeZoneInfo ConvertWindowsToIanaTimeZone(this string timeZoneToId)" file = "Extensions\\DateTimeExtensions.cs" [[classes]] @@ -61,6 +33,18 @@ ns = "FEx.Core.Extensions" file = "Extensions\\EnumerableExtensions.cs" static = true +[[extensions]] +name = "ToConcurrentObservableList" +returns = "ConcurrentObservableList" +sig = "ConcurrentObservableList ToConcurrentObservableList(this IEnumerable source)" +file = "Extensions\\EnumerableExtensions.cs" + +[[extensions]] +name = "ToConcurrentSortableObservableList" +returns = "ConcurrentSortableObservableList" +sig = "ConcurrentSortableObservableList ToConcurrentSortableObservableList(this IEnumerable source)" +file = "Extensions\\EnumerableExtensions.cs" + [[classes]] name = "JsonExtensions" ns = "FEx.Core.Extensions" @@ -69,8 +53,8 @@ static = true [[extensions]] name = "SafeSerializeObject" -sig = "string SafeSerializeObject(this object initializeParameter)" returns = "string" +sig = "string SafeSerializeObject(this object initializeParameter)" file = "Extensions\\JsonExtensions.cs" [[classes]] @@ -81,8 +65,8 @@ static = true [[extensions]] name = "ComputeMd5HashFromArguments" -sig = "string ComputeMd5HashFromArguments(this object[] arguments)" returns = "string" +sig = "string ComputeMd5HashFromArguments(this object[] arguments)" summary = "Generate MD5 hash from combined arguments" file = "Extensions\\StringExtensions.cs" @@ -92,53 +76,444 @@ ns = "FEx.Core.Helpers" base = "DefaultContractResolver" file = "Helpers\\SafeContractResolver.cs" +[[properties]] +parent = "SafeContractResolver" +name = "Singleton" +sig = "static SafeContractResolver Singleton { get; }" +returns = "SafeContractResolver" +file = "Helpers\\SafeContractResolver.cs" +static = true + +[[methods]] +parent = "SafeContractResolver" +name = "CreateProperty" +sig = "JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)" +returns = "JsonProperty" +file = "Helpers\\SafeContractResolver.cs" + [[interfaces]] name = "IStackTraceFilter" ns = "FEx.Core.StackTraces" file = "StackTraces\\IStackTraceFilter.cs" +[[methods]] +parent = "IStackTraceFilter" +name = "Applies" +sig = "bool Applies(string logger, string msg)" +returns = "bool" +file = "StackTraces\\IStackTraceFilter.cs" + [[classes]] name = "StackTraceFilter" ns = "FEx.Core.StackTraces" base = "IStackTraceFilter" file = "StackTraces\\StackTraceFilter.cs" +[[methods]] +parent = "StackTraceFilter" +name = "Applies" +sig = "bool Applies(string logger, string msg)" +returns = "bool" +file = "StackTraces\\StackTraceFilter.cs" + [[classes]] name = "StackTraceFrame" ns = "FEx.Core.StackTraces" base = "IEquatable" file = "StackTraces\\StackTraceFrame.cs" +[[properties]] +parent = "StackTraceFrame" +name = "Column" +sig = "int Column { get; set; }" +returns = "int" +file = "StackTraces\\StackTraceFrame.cs" + +[[properties]] +parent = "StackTraceFrame" +name = "Filename" +sig = "string Filename { get; set; }" +returns = "string" +file = "StackTraces\\StackTraceFrame.cs" + +[[properties]] +parent = "StackTraceFrame" +name = "Line" +sig = "int Line { get; set; }" +returns = "int" +file = "StackTraces\\StackTraceFrame.cs" + +[[properties]] +parent = "StackTraceFrame" +name = "Method" +sig = "string Method { get; set; }" +returns = "string" +file = "StackTraces\\StackTraceFrame.cs" + +[[properties]] +parent = "StackTraceFrame" +name = "Namespace" +sig = "string Namespace { get; set; }" +returns = "string" +file = "StackTraces\\StackTraceFrame.cs" + +[[properties]] +parent = "StackTraceFrame" +name = "Type" +sig = "string Type { get; set; }" +returns = "string" +file = "StackTraces\\StackTraceFrame.cs" + +[[properties]] +parent = "StackTraceFrame" +name = "FileExists" +sig = "bool FileExists { get; set; }" +returns = "bool" +file = "StackTraces\\StackTraceFrame.cs" + +[[properties]] +parent = "StackTraceFrame" +name = "FullFilename" +sig = "string FullFilename { get; set; }" +returns = "string" +file = "StackTraces\\StackTraceFrame.cs" + +[[properties]] +parent = "StackTraceFrame" +name = "FullTypeName" +sig = "string FullTypeName { get; }" +returns = "string" +file = "StackTraces\\StackTraceFrame.cs" + +[[methods]] +parent = "StackTraceFrame" +name = "Equals" +sig = "bool Equals(StackTraceFrame other)" +returns = "bool" +file = "StackTraces\\StackTraceFrame.cs" + +[[methods]] +parent = "StackTraceFrame" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +file = "StackTraces\\StackTraceFrame.cs" + +[[methods]] +parent = "StackTraceFrame" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +file = "StackTraces\\StackTraceFrame.cs" + [[classes]] name = "StackTraceGenerator" ns = "FEx.Core.StackTraces" base = "IStackTraceProvider" file = "StackTraces\\StackTraceGenerator.cs" +[[properties]] +parent = "StackTraceGenerator" +name = "DotNotFixDynamicProxyStackTrace" +sig = "bool DotNotFixDynamicProxyStackTrace { get; set; }" +returns = "bool" +file = "StackTraces\\StackTraceGenerator.cs" + +[[ctors]] +parent = "StackTraceGenerator" +sig = "StackTraceGenerator(params IStackTraceFilter[] stackTraceFilters)" +file = "StackTraces\\StackTraceGenerator.cs" + +[[methods]] +parent = "StackTraceGenerator" +name = "GetStackTrace" +sig = "StackTrace GetStackTrace()" +returns = "StackTrace" +file = "StackTraces\\StackTraceGenerator.cs" + +[[methods]] +parent = "StackTraceGenerator" +name = "GetStackTraceInfo" +sig = "StackTraceInfo GetStackTraceInfo(string logger = null, string message = null)" +returns = "StackTraceInfo" +file = "StackTraces\\StackTraceGenerator.cs" + [[classes]] name = "StackTraceInfo" ns = "FEx.Core.StackTraces" base = "IEquatable" file = "StackTraces\\StackTraceInfo.cs" +[[properties]] +parent = "StackTraceInfo" +name = "Frames" +sig = "StackTraceFrame[] Frames { get; set; }" +returns = "StackTraceFrame[]" +file = "StackTraces\\StackTraceInfo.cs" + +[[methods]] +parent = "StackTraceInfo" +name = "Equals" +sig = "bool Equals(StackTraceInfo other)" +returns = "bool" +file = "StackTraces\\StackTraceInfo.cs" + +[[methods]] +parent = "StackTraceInfo" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +file = "StackTraces\\StackTraceInfo.cs" + +[[methods]] +parent = "StackTraceInfo" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +file = "StackTraces\\StackTraceInfo.cs" + [[classes]] name = "FExArgumentlessSubject" ns = "FEx.Core.Subjects" base = "FExSubject" file = "Subjects\\FExArgumentlessSubject.cs" +[[methods]] +parent = "FExArgumentlessSubject" +name = "OnNext" +sig = "void OnNext()" +returns = "void" +file = "Subjects\\FExArgumentlessSubject.cs" + [[classes]] name = "NavigationFlowSubject" ns = "FEx.Core.Subjects" base = "FExBehaviorSubject>, INavigationFlowSubject" file = "Subjects\\NavigationFlowSubject.cs" +[[ctors]] +parent = "NavigationFlowSubject" +sig = "NavigationFlowSubject()" +file = "Subjects\\NavigationFlowSubject.cs" + +[[methods]] +parent = "NavigationFlowSubject" +name = "OnNext" +sig = "void OnNext(NavigationFlowChange value)" +returns = "void" +file = "Subjects\\NavigationFlowSubject.cs" + +[[methods]] +parent = "NavigationFlowSubject" +name = "Pop" +sig = "void Pop(Type pageType)" +returns = "void" +file = "Subjects\\NavigationFlowSubject.cs" + +[[methods]] +parent = "NavigationFlowSubject" +name = "Push" +sig = "void Push(Type pageType)" +returns = "void" +file = "Subjects\\NavigationFlowSubject.cs" + [[classes]] name = "TasksInfoSubject" ns = "FEx.Core.Subjects" base = "FExBehaviorSubject>, ITasksInfoSubject" file = "Subjects\\TasksInfoSubject.cs" +[[ctors]] +parent = "TasksInfoSubject" +sig = "TasksInfoSubject(ILogger logger)" +file = "Subjects\\TasksInfoSubject.cs" + +[[methods]] +parent = "TasksInfoSubject" +name = "AddTask" +sig = "void AddTask(ITaskWrapperBase value)" +returns = "void" +file = "Subjects\\TasksInfoSubject.cs" + +[[methods]] +parent = "TasksInfoSubject" +name = "AddTask" +sig = "void AddTask(Guid taskId)" +returns = "void" +file = "Subjects\\TasksInfoSubject.cs" + +[[methods]] +parent = "TasksInfoSubject" +name = "RemoveTask" +sig = "void RemoveTask(ITaskWrapperBase value)" +returns = "void" +file = "Subjects\\TasksInfoSubject.cs" + +[[methods]] +parent = "TasksInfoSubject" +name = "RemoveTask" +sig = "void RemoveTask(Guid taskId)" +returns = "void" +file = "Subjects\\TasksInfoSubject.cs" + +[[methods]] +parent = "TasksInfoSubject" +name = "Dispose" +sig = "void Dispose(bool isDisposing)" +returns = "void" +file = "Subjects\\TasksInfoSubject.cs" + +[[classes]] +name = "AppInfoProvider" +ns = "FEx.Core.Utilities" +base = "IAppInfoProvider" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "EntryAssemblyName" +sig = "string EntryAssemblyName { get; }" +returns = "string" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "EntryAssembly" +sig = "Assembly EntryAssembly { get; }" +returns = "Assembly" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "EntryAssemblyLocation" +sig = "FileInfo EntryAssemblyLocation { get; }" +returns = "FileInfo" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "Name" +sig = "string Name { get; }" +returns = "string" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "Version" +sig = "Version Version { get; }" +returns = "Version" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "VersionString" +sig = "string VersionString { get; }" +returns = "string" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "Company" +sig = "string Company { get; }" +returns = "string" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "Copyright" +sig = "string Copyright { get; }" +returns = "string" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "NameAndVersionWithPrefix" +sig = "string NameAndVersionWithPrefix { get; }" +returns = "string" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "NameLineVersion" +sig = "string NameLineVersion { get; }" +returns = "string" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "NameLineVersionWithPrefix" +sig = "string NameLineVersionWithPrefix { get; }" +returns = "string" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "NameAndVersion" +sig = "string NameAndVersion { get; }" +returns = "string" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "UserData" +sig = "DirectoryInfo UserData { get; }" +returns = "DirectoryInfo" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "UserDataPath" +sig = "string UserDataPath { get; }" +returns = "string" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "AppData" +sig = "DirectoryInfo AppData { get; }" +returns = "DirectoryInfo" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "AppDataPath" +sig = "string AppDataPath { get; }" +returns = "string" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "UserSettingsPath" +sig = "string UserSettingsPath { get; }" +returns = "string" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "LogDirPath" +sig = "string LogDirPath { get; }" +returns = "string" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "LogFilePath" +sig = "string LogFilePath { get; }" +returns = "string" +file = "Utilities\\AppInfoProvider.cs" + +[[properties]] +parent = "AppInfoProvider" +name = "AppInfo" +sig = "IAppInfo AppInfo { get; }" +returns = "IAppInfo" +file = "Utilities\\AppInfoProvider.cs" + +[[ctors]] +parent = "AppInfoProvider" +sig = "AppInfoProvider(IAppInfo appInfo)" +file = "Utilities\\AppInfoProvider.cs" + [[classes]] name = "ExceptionHandler" ns = "FEx.Core.Utilities" @@ -146,3 +521,485 @@ base = "ExceptionHandlerBase" summary = "Exception extensions class." file = "Utilities\\ExceptionHandler.cs" +[[ctors]] +parent = "ExceptionHandler" +sig = "ExceptionHandler(IFExLogger logger)" +file = "Utilities\\ExceptionHandler.cs" + +[[methods]] +parent = "ExceptionHandler" +name = "Handle" +sig = "void Handle(Exception exception, IExceptionHandlerOptions options = null)" +returns = "void" +file = "Utilities\\ExceptionHandler.cs" + +[[methods]] +parent = "ExceptionHandler" +name = "HandleException" +sig = "void HandleException(Exception exception, IExceptionHandlerOptions options)" +returns = "void" +file = "Utilities\\ExceptionHandler.cs" + +[[classes]] +name = "ConcurrentHashSet" +ns = "FEx.Core.Collections.Concurrent" +base = "ISet, IReadOnlyCollection, IDisposable" +summary = "Thread-safe HashSet using composition with ReaderWriterLockSlim. https://stackoverflow.com/questions/18922985/concurrent-hashsett-in-net-framework" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[properties]] +parent = "ConcurrentHashSet" +name = "Count" +sig = "int Count { get; }" +returns = "int" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[properties]] +parent = "ConcurrentHashSet" +name = "IsReadOnly" +sig = "bool IsReadOnly { get; }" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[ctors]] +parent = "ConcurrentHashSet" +sig = "ConcurrentHashSet()" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[ctors]] +parent = "ConcurrentHashSet" +sig = "ConcurrentHashSet(IEnumerable collection)" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[ctors]] +parent = "ConcurrentHashSet" +sig = "ConcurrentHashSet(IEqualityComparer comparer)" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[ctors]] +parent = "ConcurrentHashSet" +sig = "ConcurrentHashSet(IEnumerable collection, IEqualityComparer comparer)" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "Remove" +sig = "bool Remove(T item)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "Clear" +sig = "void Clear()" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "Contains" +sig = "bool Contains(T item)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "CopyTo" +sig = "void CopyTo(T[] array, int arrayIndex)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "GetEnumerator" +sig = "IEnumerator GetEnumerator()" +returns = "IEnumerator" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "Add" +sig = "bool Add(T item)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "UnionWith" +sig = "void UnionWith(IEnumerable other)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "IntersectWith" +sig = "void IntersectWith(IEnumerable other)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "ExceptWith" +sig = "void ExceptWith(IEnumerable other)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "SymmetricExceptWith" +sig = "void SymmetricExceptWith(IEnumerable other)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "IsSubsetOf" +sig = "bool IsSubsetOf(IEnumerable other)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "IsSupersetOf" +sig = "bool IsSupersetOf(IEnumerable other)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "IsProperSupersetOf" +sig = "bool IsProperSupersetOf(IEnumerable other)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "IsProperSubsetOf" +sig = "bool IsProperSubsetOf(IEnumerable other)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "Overlaps" +sig = "bool Overlaps(IEnumerable other)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "SetEquals" +sig = "bool SetEquals(IEnumerable other)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "RemoveWhere" +sig = "int RemoveWhere(Predicate match)" +returns = "int" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "AddRange" +sig = "void AddRange(IEnumerable items)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "GetSnapshot" +sig = "List GetSnapshot()" +returns = "List" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "RunLocked" +sig = "TR RunLocked(Func func)" +returns = "TR" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "RunLocked" +sig = "void RunLocked(Action action)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[methods]] +parent = "ConcurrentHashSet" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentHashSet.cs" + +[[classes]] +name = "ConcurrentObservableDictionary" +ns = "FEx.Core.Collections.Concurrent" +base = "BaseConcurrentList>, IDictionary, IDictionary, IReadOnlyDictionary, INotifyCollectionChanged, INotifyPropertyChanged" +summary = "Based on https://github.com/ChadBurggraf/parallel-extensions-extras" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[properties]] +parent = "ConcurrentObservableDictionary" +name = "Count" +sig = "int Count { get; }" +returns = "int" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[properties]] +parent = "ConcurrentObservableDictionary" +name = "IsSynchronized" +sig = "bool IsSynchronized { get; }" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[properties]] +parent = "ConcurrentObservableDictionary" +name = "SyncRoot" +sig = "object SyncRoot { get; }" +returns = "object" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[properties]] +parent = "ConcurrentObservableDictionary" +name = "IsFixedSize" +sig = "bool IsFixedSize { get; }" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[properties]] +parent = "ConcurrentObservableDictionary" +name = "IsReadOnly" +sig = "bool IsReadOnly { get; }" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[properties]] +parent = "ConcurrentObservableDictionary" +name = "Keys" +sig = "ICollection Keys { get; }" +returns = "ICollection" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[properties]] +parent = "ConcurrentObservableDictionary" +name = "Values" +sig = "ICollection Values { get; }" +returns = "ICollection" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[ctors]] +parent = "ConcurrentObservableDictionary" +sig = "ConcurrentObservableDictionary()" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[methods]] +parent = "ConcurrentObservableDictionary" +name = "CopyTo" +sig = "void CopyTo(Array array, int index)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[methods]] +parent = "ConcurrentObservableDictionary" +name = "Add" +sig = "void Add(object key, object value)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[methods]] +parent = "ConcurrentObservableDictionary" +name = "Contains" +sig = "bool Contains(object key)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[methods]] +parent = "ConcurrentObservableDictionary" +name = "GetEnumerator" +sig = "IDictionaryEnumerator GetEnumerator()" +returns = "IDictionaryEnumerator" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[methods]] +parent = "ConcurrentObservableDictionary" +name = "Remove" +sig = "void Remove(object key)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[methods]] +parent = "ConcurrentObservableDictionary" +name = "Clear" +sig = "void Clear()" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[methods]] +parent = "ConcurrentObservableDictionary" +name = "Add" +sig = "void Add(TKey key, TValue value)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[methods]] +parent = "ConcurrentObservableDictionary" +name = "ContainsKey" +sig = "bool ContainsKey(TKey key)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[methods]] +parent = "ConcurrentObservableDictionary" +name = "Remove" +sig = "bool Remove(TKey key)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[methods]] +parent = "ConcurrentObservableDictionary" +name = "TryGetValue" +sig = "bool TryGetValue(TKey key, out TValue value)" +returns = "bool" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[methods]] +parent = "ConcurrentObservableDictionary" +name = "TryAdd" +sig = "bool TryAdd(TKey key, TValue value)" +returns = "bool" +summary = "Attempts to add the specified key and value to the ." +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[methods]] +parent = "ConcurrentObservableDictionary" +name = "AddOrUpdate" +sig = "TValue AddOrUpdate(TKey key, Func addValueFactory, Func updateValueFactory)" +returns = "TValue" +summary = "Uses the specified functions to add a key/value pair to the if the key does not already exist, or to update a key/value pair in the if the key already exists." +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[methods]] +parent = "ConcurrentObservableDictionary" +name = "Dispatch" +sig = "void Dispatch(Action action)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[methods]] +parent = "ConcurrentObservableDictionary" +name = "OnPropertyChanged" +sig = "void OnPropertyChanged(PropertyChangedEventArgs e)" +returns = "void" +summary = "Raises a PropertyChanged event (per )." +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[methods]] +parent = "ConcurrentObservableDictionary" +name = "OnCollectionChanged" +sig = "void OnCollectionChanged(NotifyCollectionChangedEventArgs e)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[methods]] +parent = "ConcurrentObservableDictionary" +name = "OnIndexerPropertyChanged" +sig = "void OnIndexerPropertyChanged()" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentObservableDictionary.cs" + +[[classes]] +name = "ConcurrentObservableList" +ns = "FEx.Core.Collections.Concurrent" +base = "ConcurrentList, IObservableCollection" +file = "Collections\\Concurrent\\ConcurrentObservableList.cs" + +[[properties]] +parent = "ConcurrentObservableList" +name = "CollectionChangedObservable" +sig = "IObservable> CollectionChangedObservable { get; }" +returns = "IObservable>" +file = "Collections\\Concurrent\\ConcurrentObservableList.cs" + +[[ctors]] +parent = "ConcurrentObservableList" +sig = "ConcurrentObservableList()" +summary = "Initializes a new instance of the ConcurrentObservableList class that contains elements copied from the specified collection and has sufficient capacity to accommodate the number of elements copied." +file = "Collections\\Concurrent\\ConcurrentObservableList.cs" + +[[ctors]] +parent = "ConcurrentObservableList" +sig = "ConcurrentObservableList(IEnumerable collection)" +file = "Collections\\Concurrent\\ConcurrentObservableList.cs" + +[[methods]] +parent = "ConcurrentObservableList" +name = "SuspendCount" +sig = "IDisposable SuspendCount()" +returns = "IDisposable" +summary = "Suspends count notifications." +file = "Collections\\Concurrent\\ConcurrentObservableList.cs" + +[[methods]] +parent = "ConcurrentObservableList" +name = "SuspendNotifications" +sig = "IDisposable SuspendNotifications()" +returns = "IDisposable" +summary = "Suspends notifications. When disposed, a reset notification is fired." +file = "Collections\\Concurrent\\ConcurrentObservableList.cs" + +[[methods]] +parent = "ConcurrentObservableList" +name = "Load" +sig = "void Load(IEnumerable items)" +returns = "void" +summary = "Clears the list and Loads the specified items." +file = "Collections\\Concurrent\\ConcurrentObservableList.cs" + +[[methods]] +parent = "ConcurrentObservableList" +name = "ResumeEvents" +sig = "void ResumeEvents()" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentObservableList.cs" + +[[methods]] +parent = "ConcurrentObservableList" +name = "OnPropertyChanged" +sig = "void OnPropertyChanged(PropertyChangedEventArgs e)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentObservableList.cs" + +[[methods]] +parent = "ConcurrentObservableList" +name = "OnCollectionChanged" +sig = "void OnCollectionChanged(NotifyCollectionChangedEventArgs e)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentObservableList.cs" + +[[classes]] +name = "ConcurrentSortableObservableList" +ns = "FEx.Core.Collections.Concurrent" +base = "ConcurrentObservableList" +file = "Collections\\Concurrent\\ConcurrentSortableObservableList.cs" + +[[ctors]] +parent = "ConcurrentSortableObservableList" +sig = "ConcurrentSortableObservableList()" +file = "Collections\\Concurrent\\ConcurrentSortableObservableList.cs" + +[[ctors]] +parent = "ConcurrentSortableObservableList" +sig = "ConcurrentSortableObservableList(IEnumerable collection)" +file = "Collections\\Concurrent\\ConcurrentSortableObservableList.cs" + +[[methods]] +parent = "ConcurrentSortableObservableList" +name = "Sort" +sig = "void Sort(ListSortDirection order)" +returns = "void" +file = "Collections\\Concurrent\\ConcurrentSortableObservableList.cs" + diff --git a/.api-surface/FEx/DependencyInjection.Abstractions.toml b/.api-surface/FEx/DependencyInjection.Abstractions.toml index 1ea5c2d5..894d2b9b 100644 --- a/.api-surface/FEx/DependencyInjection.Abstractions.toml +++ b/.api-surface/FEx/DependencyInjection.Abstractions.toml @@ -8,11 +8,274 @@ ns = "FEx.DependencyInjection.Abstractions" base = "IFExServiceProvider" file = "FExServiceProvider.cs" +[[properties]] +parent = "FExServiceProvider" +name = "Instance" +sig = "static FExServiceProvider Instance { get; }" +returns = "FExServiceProvider" +file = "FExServiceProvider.cs" +static = true + +[[properties]] +parent = "FExServiceProvider" +name = "ServiceContainer" +sig = "static IFExServiceContainer ServiceContainer { get; }" +returns = "IFExServiceContainer" +summary = "Retrieves the instance. ⚠️ This is discouraged and should only be used where Dependency Injection is unavailable." +file = "FExServiceProvider.cs" +static = true + +[[methods]] +parent = "FExServiceProvider" +name = "GetInstance" +sig = "T GetInstance()" +returns = "T" +summary = "Retrieves the instance. ⚠️ This is discouraged and should only be used where Dependency Injection is unavailable." +file = "FExServiceProvider.cs" + +[[methods]] +parent = "FExServiceProvider" +name = "GetInstance" +sig = "object GetInstance(Type serviceType)" +returns = "object" +summary = "Retrieves the instance of the specified type." +file = "FExServiceProvider.cs" + +[[methods]] +parent = "FExServiceProvider" +name = "GetRequiredService" +sig = "T GetRequiredService()" +returns = "T" +summary = "Gets the required service object of the specified type." +file = "FExServiceProvider.cs" + +[[methods]] +parent = "FExServiceProvider" +name = "GetRequiredService" +sig = "T GetRequiredService(Type serviceType)" +returns = "T" +summary = "Gets the required service object of the specified type." +file = "FExServiceProvider.cs" + +[[methods]] +parent = "FExServiceProvider" +name = "GetRequiredService" +sig = "object GetRequiredService(Type serviceType)" +returns = "object" +summary = "Gets the required service object of the specified type." +file = "FExServiceProvider.cs" + +[[methods]] +parent = "FExServiceProvider" +name = "TryResolveService" +sig = "T TryResolveService()" +returns = "T" +summary = "Tries to resolve service of the specified type." +file = "FExServiceProvider.cs" + +[[methods]] +parent = "FExServiceProvider" +name = "GetContainer" +sig = "TContainer GetContainer() where TContainer : class" +returns = "TContainer" +summary = "Gets the container of the specified type." +file = "FExServiceProvider.cs" + +[[methods]] +parent = "FExServiceProvider" +name = "CreateScope" +sig = "IScopeProvider CreateScope()" +returns = "IScopeProvider" +summary = "Creates a scope for scoped services - not supported by StrongInject containers." +file = "FExServiceProvider.cs" + +[[methods]] +parent = "FExServiceProvider" +name = "ConfigureServiceProviderAsync" +sig = "ValueTask ConfigureServiceProviderAsync()" +returns = "ValueTask" +summary = "No-op implementation for the static provider as it delegates to the actual providers." +file = "FExServiceProvider.cs" + +[[methods]] +parent = "FExServiceProvider" +name = "GetService" +sig = "object GetService(Type serviceType)" +returns = "object" +summary = "Gets the service object of the specified type." +file = "FExServiceProvider.cs" + +[[methods]] +parent = "FExServiceProvider" +name = "Get" +sig = "static T Get()" +returns = "T" +summary = "Retrieves the instance. ⚠️ This is discouraged and should only be used where Dependency Injection is unavailable." +file = "FExServiceProvider.cs" +static = true + +[[methods]] +parent = "FExServiceProvider" +name = "GetAsync" +sig = "static Task GetAsync()" +returns = "Task" +summary = "Retrieves the instance asynchronously. ⚠️ This is discouraged and should only be used where Dependency Injection is unavailable." +file = "FExServiceProvider.cs" +static = true + +[[methods]] +parent = "FExServiceProvider" +name = "GetAll" +sig = "static IEnumerable GetAll()" +returns = "IEnumerable" +summary = "Retrieves the instances. ⚠️ This is discouraged and should only be used where Dependency Injection is unavailable." +file = "FExServiceProvider.cs" +static = true + +[[methods]] +parent = "FExServiceProvider" +name = "TryGetAll" +sig = "static IEnumerable TryGetAll()" +returns = "IEnumerable" +summary = "Retrieves the instances or returns empty enumerable if none found. ⚠️ This is discouraged and should only be used where Dependency Injection is unavailable." +file = "FExServiceProvider.cs" +static = true + +[[methods]] +parent = "FExServiceProvider" +name = "GetAllAsync" +sig = "static Task> GetAllAsync()" +returns = "Task>" +summary = "Retrieves the instances asynchronously. ⚠️ This is discouraged and should only be used where Dependency Injection is unavailable." +file = "FExServiceProvider.cs" +static = true + +[[methods]] +parent = "FExServiceProvider" +name = "GetOrDefault" +sig = "static T GetOrDefault()" +returns = "T" +summary = "Retrieves the instance or returns default value. ⚠️ This is discouraged and should only be used where Dependency Injection is unavailable." +file = "FExServiceProvider.cs" +static = true + +[[methods]] +parent = "FExServiceProvider" +name = "GetOrDefault" +sig = "static T GetOrDefault(T fallback)" +returns = "T" +file = "FExServiceProvider.cs" +static = true + +[[methods]] +parent = "FExServiceProvider" +name = "Release" +sig = "static void Release()" +returns = "void" +summary = "Disposes the container." +file = "FExServiceProvider.cs" +static = true + +[[methods]] +parent = "FExServiceProvider" +name = "InitializeAsync" +sig = "static ValueTask InitializeAsync() where TContainer : class, IDisposable, new()" +returns = "ValueTask" +summary = "Default startup point of application. Creates DI container instance and wraps into service, that allows to distribute its registrations around the app." +file = "FExServiceProvider.cs" +static = true + +[[methods]] +parent = "FExServiceProvider" +name = "InitializeAsync" +sig = "static ValueTask InitializeAsync(IServiceCollection services) where TContainer : class, IDisposable, new()" +returns = "ValueTask" +file = "FExServiceProvider.cs" +static = true + +[[methods]] +parent = "FExServiceProvider" +name = "InitializeAsync" +sig = "static ValueTask InitializeAsync(IServiceCollection services, Action configureContainer) where TContainer : class, IDisposable, new()" +returns = "ValueTask" +file = "FExServiceProvider.cs" +static = true + +[[methods]] +parent = "FExServiceProvider" +name = "GetDefaultContainer" +sig = "static TModule GetDefaultContainer() where TModule : class" +returns = "TModule" +file = "FExServiceProvider.cs" +static = true + +[[methods]] +parent = "FExServiceProvider" +name = "RegisterDependenciesAsync" +sig = "static Task RegisterDependenciesAsync( Func serviceProviderConfiguration)" +returns = "Task" +file = "FExServiceProvider.cs" +static = true + +[[methods]] +parent = "FExServiceProvider" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +summary = "Disposes the service provider." +file = "FExServiceProvider.cs" + [[classes]] name = "InitializeModule" ns = "FEx.DependencyInjection.Abstractions" -base = "FExInitializable, IInitializeModule - where TContainer : class" +base = "FExInitializable, IInitializeModule" +file = "InitializeModule.cs" + +[[properties]] +parent = "InitializeModule" +name = "HasBeenCompleted" +sig = "bool HasBeenCompleted { get; }" +returns = "bool" +file = "InitializeModule.cs" + +[[ctors]] +parent = "InitializeModule" +sig = "InitializeModule(params IFExInitializable[] dependencies)" +file = "InitializeModule.cs" + +[[methods]] +parent = "InitializeModule" +name = "RegisterServices" +sig = "void RegisterServices(TEngineContext context)" +returns = "void" +file = "InitializeModule.cs" + +[[methods]] +parent = "InitializeModule" +name = "CompleteInitializationAsync" +sig = "ValueTask CompleteInitializationAsync(TEngineContext context)" +returns = "ValueTask" +file = "InitializeModule.cs" + +[[methods]] +parent = "InitializeModule" +name = "OnCompleteInitializationAsync" +sig = "ValueTask OnCompleteInitializationAsync(TEngineContext context)" +returns = "ValueTask" +file = "InitializeModule.cs" + +[[methods]] +parent = "InitializeModule" +name = "RegisterServices" +sig = "void RegisterServices(TContainer container, TEngineContext context)" +returns = "void" +file = "InitializeModule.cs" + +[[methods]] +parent = "InitializeModule" +name = "GetModule" +sig = "TContainer GetModule()" +returns = "TContainer" file = "InitializeModule.cs" [[classes]] @@ -21,12 +284,42 @@ ns = "FEx.DependencyInjection.Abstractions" base = "InitializeModule" file = "InitializeOnlyModule.cs" +[[methods]] +parent = "InitializeOnlyModule" +name = "RegisterServices" +sig = "void RegisterServices(object container, IServiceCollection services)" +returns = "void" +file = "InitializeOnlyModule.cs" + +[[methods]] +parent = "InitializeOnlyModule" +name = "GetModule" +sig = "object GetModule()" +returns = "object" +file = "InitializeOnlyModule.cs" + [[classes]] name = "StaticsBase" ns = "FEx.DependencyInjection.Abstractions.Basics" base = "FExInitializable" file = "Basics\\StaticsBase.cs" +[[properties]] +parent = "StaticsBase" +name = "ServiceProvider" +sig = "static IFExServiceProvider ServiceProvider { get; set; }" +returns = "IFExServiceProvider" +file = "Basics\\StaticsBase.cs" +static = true + +[[methods]] +parent = "StaticsBase" +name = "Get" +sig = "static T Get(Func localFactory, Func fallback = null, [CallerMemberName] string paramName = null) where T : class" +returns = "T" +file = "Basics\\StaticsBase.cs" +static = true + [[enums]] name = "ConfigurationPriority" ns = "FEx.DependencyInjection.Abstractions.Enums" @@ -38,54 +331,258 @@ ns = "FEx.DependencyInjection.Abstractions.Extensions" file = "Extensions\\FExServiceContainerExtensions.cs" static = true +[[extensions]] +name = "RegisterServices" +returns = "void" +sig = "void RegisterServices(this IFExServiceContainer container, TContainer diContainer)" +file = "Extensions\\FExServiceContainerExtensions.cs" + +[[extensions]] +name = "ResolveOrDefault" +returns = "T" +sig = "T ResolveOrDefault(this IFExServiceContainer container)" +file = "Extensions\\FExServiceContainerExtensions.cs" + [[interfaces]] name = "IAnyConfigurator" ns = "FEx.DependencyInjection.Abstractions.Interfaces" file = "Interfaces\\IAnyConfigurator.cs" +[[properties]] +parent = "IAnyConfigurator" +name = "Priority" +sig = "ConfigurationPriority Priority { get; }" +returns = "ConfigurationPriority" +file = "Interfaces\\IAnyConfigurator.cs" + [[interfaces]] name = "IAsyncConfigurator" ns = "FEx.DependencyInjection.Abstractions.Interfaces" +base = "IAnyConfigurator" +file = "Interfaces\\IAsyncConfigurator.cs" + +[[methods]] +parent = "IAsyncConfigurator" +name = "ConfigureAsync" +sig = "Task ConfigureAsync()" +returns = "Task" file = "Interfaces\\IAsyncConfigurator.cs" [[interfaces]] name = "IConfigurator" ns = "FEx.DependencyInjection.Abstractions.Interfaces" +base = "IAnyConfigurator" +file = "Interfaces\\IConfigurator.cs" + +[[methods]] +parent = "IConfigurator" +name = "Configure" +sig = "void Configure()" +returns = "void" file = "Interfaces\\IConfigurator.cs" [[interfaces]] name = "IFExDependencyInjectionContainer" ns = "FEx.DependencyInjection.Abstractions.Interfaces" +base = "IContainer, IContainer, IContainer, IContainer, IContainer, IContainer" file = "Interfaces\\IFExDependencyInjectionContainer.cs" [[interfaces]] name = "IFExServiceContainer" ns = "FEx.DependencyInjection.Abstractions.Interfaces" +base = "IDisposable" +file = "Interfaces\\IFExServiceContainer.cs" + +[[methods]] +parent = "IFExServiceContainer" +name = "RegisterServices" +sig = "void RegisterServices(TContainer container, IServiceCollection services) where TContainer : class, IDisposable" +returns = "void" +file = "Interfaces\\IFExServiceContainer.cs" + +[[methods]] +parent = "IFExServiceContainer" +name = "ResolveService" +sig = "T ResolveService()" +returns = "T" +file = "Interfaces\\IFExServiceContainer.cs" + +[[methods]] +parent = "IFExServiceContainer" +name = "ResolveServiceAsync" +sig = "Task ResolveServiceAsync()" +returns = "Task" +file = "Interfaces\\IFExServiceContainer.cs" + +[[methods]] +parent = "IFExServiceContainer" +name = "ResolveServicesAsync" +sig = "Task> ResolveServicesAsync()" +returns = "Task>" +file = "Interfaces\\IFExServiceContainer.cs" + +[[methods]] +parent = "IFExServiceContainer" +name = "ResolveServices" +sig = "IEnumerable ResolveServices()" +returns = "IEnumerable" +file = "Interfaces\\IFExServiceContainer.cs" + +[[methods]] +parent = "IFExServiceContainer" +name = "TryResolveServices" +sig = "IEnumerable TryResolveServices()" +returns = "IEnumerable" +file = "Interfaces\\IFExServiceContainer.cs" + +[[methods]] +parent = "IFExServiceContainer" +name = "ResolveOrDefault" +sig = "T ResolveOrDefault(T fallback)" +returns = "T" +file = "Interfaces\\IFExServiceContainer.cs" + +[[methods]] +parent = "IFExServiceContainer" +name = "Release" +sig = "void Release()" +returns = "void" file = "Interfaces\\IFExServiceContainer.cs" [[interfaces]] name = "IFExServiceProvider" ns = "FEx.DependencyInjection.Abstractions.Interfaces" +base = "IServiceProvider, IDisposable" +file = "Interfaces\\IFExServiceProvider.cs" + +[[methods]] +parent = "IFExServiceProvider" +name = "GetRequiredService" +sig = "T GetRequiredService()" +returns = "T" +file = "Interfaces\\IFExServiceProvider.cs" + +[[methods]] +parent = "IFExServiceProvider" +name = "TryResolveService" +sig = "T TryResolveService()" +returns = "T" +file = "Interfaces\\IFExServiceProvider.cs" + +[[methods]] +parent = "IFExServiceProvider" +name = "GetRequiredService" +sig = "T GetRequiredService(Type serviceType)" +returns = "T" +file = "Interfaces\\IFExServiceProvider.cs" + +[[methods]] +parent = "IFExServiceProvider" +name = "GetRequiredService" +sig = "object GetRequiredService(Type serviceType)" +returns = "object" +file = "Interfaces\\IFExServiceProvider.cs" + +[[methods]] +parent = "IFExServiceProvider" +name = "GetContainer" +sig = "TContainer GetContainer() where TContainer : class" +returns = "TContainer" +file = "Interfaces\\IFExServiceProvider.cs" + +[[methods]] +parent = "IFExServiceProvider" +name = "CreateScope" +sig = "IScopeProvider CreateScope()" +returns = "IScopeProvider" +file = "Interfaces\\IFExServiceProvider.cs" + +[[methods]] +parent = "IFExServiceProvider" +name = "GetInstance" +sig = "T GetInstance()" +returns = "T" +file = "Interfaces\\IFExServiceProvider.cs" + +[[methods]] +parent = "IFExServiceProvider" +name = "GetInstance" +sig = "object GetInstance(Type serviceType)" +returns = "object" +file = "Interfaces\\IFExServiceProvider.cs" + +[[methods]] +parent = "IFExServiceProvider" +name = "ConfigureServiceProviderAsync" +sig = "ValueTask ConfigureServiceProviderAsync()" +returns = "ValueTask" +summary = "Configure the service provider for external DI engine integration. Only called when external DI is opt-in enabled." file = "Interfaces\\IFExServiceProvider.cs" [[interfaces]] name = "IFExStrongInjectServiceProvider" ns = "FEx.DependencyInjection.Abstractions.Interfaces" +base = "IFExServiceProvider" +file = "Interfaces\\IFExStrongInjectServiceProvider.cs" + +[[methods]] +parent = "IFExStrongInjectServiceProvider" +name = "SetServiceProvider" +sig = "void SetServiceProvider(TContainer container) where TContainer : class, IDisposable" +returns = "void" file = "Interfaces\\IFExStrongInjectServiceProvider.cs" [[interfaces]] name = "IInitializeModule" ns = "FEx.DependencyInjection.Abstractions.Interfaces" +base = "IFExInitializable" +file = "Interfaces\\IInitializeModule.cs" + +[[properties]] +parent = "IInitializeModule" +name = "HasBeenCompleted" +sig = "bool HasBeenCompleted { get; }" +returns = "bool" +file = "Interfaces\\IInitializeModule.cs" + +[[methods]] +parent = "IInitializeModule" +name = "RegisterServices" +sig = "void RegisterServices(TEngineContext context)" +returns = "void" +file = "Interfaces\\IInitializeModule.cs" + +[[methods]] +parent = "IInitializeModule" +name = "CompleteInitializationAsync" +sig = "ValueTask CompleteInitializationAsync(TEngineContext context)" +returns = "ValueTask" file = "Interfaces\\IInitializeModule.cs" [[interfaces]] name = "IMicrosoftDIConfigurator" ns = "FEx.DependencyInjection.Abstractions.Interfaces" +base = "IMicrosoftDIConfigurator" +file = "Interfaces\\IMicrosoftDIConfigurator.cs" + +[[methods]] +parent = "IMicrosoftDIConfigurator" +name = "RegisterServices" +sig = "void RegisterServices(IServiceCollection services, TContainer container)" +returns = "void" file = "Interfaces\\IMicrosoftDIConfigurator.cs" [[interfaces]] name = "IMicrosoftDIConfigurator" ns = "FEx.DependencyInjection.Abstractions.Interfaces" +base = "IAnyConfigurator" +file = "Interfaces\\IMicrosoftDIConfigurator.cs" + +[[methods]] +parent = "IMicrosoftDIConfigurator" +name = "RegisterServicesUsingContainer" +sig = "void RegisterServicesUsingContainer(IServiceCollection services, object container)" +returns = "void" file = "Interfaces\\IMicrosoftDIConfigurator.cs" [[interfaces]] @@ -93,3 +590,10 @@ name = "IScopeProvider" ns = "FEx.DependencyInjection.Abstractions.Interfaces" file = "Interfaces\\IScopeProvider.cs" +[[methods]] +parent = "IScopeProvider" +name = "CreateScope" +sig = "IServiceScope CreateScope()" +returns = "IServiceScope" +file = "Interfaces\\IScopeProvider.cs" + diff --git a/.api-surface/FEx/DependencyInjection.Tests.toml b/.api-surface/FEx/DependencyInjection.Tests.toml index dd7fa39b..e54aa1f0 100644 --- a/.api-surface/FEx/DependencyInjection.Tests.toml +++ b/.api-surface/FEx/DependencyInjection.Tests.toml @@ -8,6 +8,48 @@ ns = "FEx.DependencyInjection.Tests" summary = "Basic tests to validate the Multi-DI architecture works correctly. Tests the container directly instead of relying on static FExServiceProvider." file = "BasicArchitectureTests.cs" +[[methods]] +parent = "BasicArchitectureTests" +name = "StrongInjectContainer_ShouldResolveServiceContainer" +sig = "void StrongInjectContainer_ShouldResolveServiceContainer()" +returns = "void" +file = "BasicArchitectureTests.cs" + +[[methods]] +parent = "BasicArchitectureTests" +name = "StrongInjectContainer_ShouldResolveServiceProvider" +sig = "void StrongInjectContainer_ShouldResolveServiceProvider()" +returns = "void" +file = "BasicArchitectureTests.cs" + +[[methods]] +parent = "BasicArchitectureTests" +name = "StrongInjectContainer_ShouldResolveMicrosoftDIProvider" +sig = "void StrongInjectContainer_ShouldResolveMicrosoftDIProvider()" +returns = "void" +file = "BasicArchitectureTests.cs" + +[[methods]] +parent = "BasicArchitectureTests" +name = "MultiDIArchitecture_ShouldSupportGenericModules" +sig = "void MultiDIArchitecture_ShouldSupportGenericModules()" +returns = "void" +file = "BasicArchitectureTests.cs" + +[[methods]] +parent = "BasicArchitectureTests" +name = "ProviderInterface_ShouldIncludeConfigureServiceProviderAsync" +sig = "Task ProviderInterface_ShouldIncludeConfigureServiceProviderAsync()" +returns = "Task" +file = "BasicArchitectureTests.cs" + +[[methods]] +parent = "BasicArchitectureTests" +name = "TypeArchitecture_ShouldBeCompletelyAvailable" +sig = "void TypeArchitecture_ShouldBeCompletelyAvailable()" +returns = "void" +file = "BasicArchitectureTests.cs" + [[classes]] name = "EngineAgnosticTests" ns = "FEx.DependencyInjection.Tests" @@ -15,6 +57,34 @@ base = "IDisposable" summary = "Tests to verify the engine-agnostic Multi-DI architecture works correctly." file = "EngineAgnosticTests.cs" +[[methods]] +parent = "EngineAgnosticTests" +name = "GenericModuleInterface_ShouldSupportEngineSpecificContexts" +sig = "void GenericModuleInterface_ShouldSupportEngineSpecificContexts()" +returns = "void" +file = "EngineAgnosticTests.cs" + +[[methods]] +parent = "EngineAgnosticTests" +name = "BaseModuleClass_ShouldProvideContainerAccess" +sig = "Task BaseModuleClass_ShouldProvideContainerAccess()" +returns = "Task" +file = "EngineAgnosticTests.cs" + +[[methods]] +parent = "EngineAgnosticTests" +name = "FutureEngineSupport_ShouldBeStructurallyReady" +sig = "void FutureEngineSupport_ShouldBeStructurallyReady()" +returns = "void" +file = "EngineAgnosticTests.cs" + +[[methods]] +parent = "EngineAgnosticTests" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "EngineAgnosticTests.cs" + [[classes]] name = "TestInitializeModule" ns = "FEx.DependencyInjection.Tests" @@ -22,22 +92,85 @@ base = "InitializeModule" summary = "Test helper class to validate the InitializeModule base class functionality." file = "EngineAgnosticTests.cs" +[[methods]] +parent = "TestInitializeModule" +name = "TestGetModule" +sig = "IFExDependencyInjectionContainer TestGetModule()" +returns = "IFExDependencyInjectionContainer" +file = "EngineAgnosticTests.cs" + +[[methods]] +parent = "TestInitializeModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExDependencyInjectionContainer container, IServiceCollection services)" +returns = "void" +file = "EngineAgnosticTests.cs" + [[classes]] name = "MultiDITests" ns = "FEx.DependencyInjection.Tests" base = "IDisposable" file = "MultiDITests.cs" +[[methods]] +parent = "MultiDITests" +name = "StrongInjectOnly_ShouldInitializeWithoutMicrosoftDI" +sig = "Task StrongInjectOnly_ShouldInitializeWithoutMicrosoftDI()" +returns = "Task" +file = "MultiDITests.cs" + +[[methods]] +parent = "MultiDITests" +name = "EngineModules_ShouldOnlyRunForSpecificEngine" +sig = "void EngineModules_ShouldOnlyRunForSpecificEngine()" +returns = "void" +file = "MultiDITests.cs" + +[[methods]] +parent = "MultiDITests" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "MultiDITests.cs" + [[classes]] name = "SimpleArchitectureTests" ns = "FEx.DependencyInjection.Tests" summary = "Simplified tests to validate the Multi-DI architecture fundamentals." file = "SimpleArchitectureTests.cs" +[[methods]] +parent = "SimpleArchitectureTests" +name = "MultiDIArchitecture_ShouldCompileAndBuildSuccessfully" +sig = "void MultiDIArchitecture_ShouldCompileAndBuildSuccessfully()" +returns = "void" +file = "SimpleArchitectureTests.cs" + +[[methods]] +parent = "SimpleArchitectureTests" +name = "FExServiceProviderEntryPoints_ShouldExist" +sig = "void FExServiceProviderEntryPoints_ShouldExist()" +returns = "void" +file = "SimpleArchitectureTests.cs" + +[[methods]] +parent = "SimpleArchitectureTests" +name = "ProviderInterface_ShouldIncludeConfigureServiceProviderAsync" +sig = "void ProviderInterface_ShouldIncludeConfigureServiceProviderAsync()" +returns = "void" +file = "SimpleArchitectureTests.cs" + [[classes]] name = "TestContainer" ns = "FEx.DependencyInjection.Tests" -base = "TestBase, IFExDependencyInjectionContainer, IContainer, - IContainer, IContainer[]>" +base = "TestBase, IFExDependencyInjectionContainer, IContainer, IContainer, IContainer[]>" +file = "TestContainer.cs" + +[[methods]] +parent = "TestContainer" +name = "CreateLogger" +sig = "static ILogger CreateLogger()" +returns = "ILogger" file = "TestContainer.cs" +static = true diff --git a/.api-surface/FEx/DependencyInjection.toml b/.api-surface/FEx/DependencyInjection.toml index aaee0d3a..c3595aa8 100644 --- a/.api-surface/FEx/DependencyInjection.toml +++ b/.api-surface/FEx/DependencyInjection.toml @@ -8,39 +8,330 @@ ns = "FEx.DependencyInjection" base = "InitializeModule" file = "FExDependencyInjectionModule.cs" +[[properties]] +parent = "FExDependencyInjectionModule" +name = "ServiceProvider" +sig = "static FExStrongInjectServiceProvider ServiceProvider { get; }" +returns = "FExStrongInjectServiceProvider" +file = "FExDependencyInjectionModule.cs" +static = true + +[[methods]] +parent = "FExDependencyInjectionModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExDependencyInjectionContainer container, IServiceCollection services)" +returns = "void" +file = "FExDependencyInjectionModule.cs" + [[classes]] name = "FExMicrosoftDIServiceProvider" ns = "FEx.DependencyInjection" base = "IFExServiceProvider" file = "FExMicrosoftDIServiceProvider.cs" +[[ctors]] +parent = "FExMicrosoftDIServiceProvider" +sig = "FExMicrosoftDIServiceProvider(ILogger logger)" +file = "FExMicrosoftDIServiceProvider.cs" + +[[methods]] +parent = "FExMicrosoftDIServiceProvider" +name = "ConfigureServiceProviderAsync" +sig = "ValueTask ConfigureServiceProviderAsync()" +returns = "ValueTask" +summary = "Configure Microsoft DI service provider by discovering and running Microsoft DI specific modules." +file = "FExMicrosoftDIServiceProvider.cs" + +[[methods]] +parent = "FExMicrosoftDIServiceProvider" +name = "GetRequiredService" +sig = "T GetRequiredService()" +returns = "T" +summary = "Get service of type from the ." +file = "FExMicrosoftDIServiceProvider.cs" + +[[methods]] +parent = "FExMicrosoftDIServiceProvider" +name = "TryResolveService" +sig = "T TryResolveService()" +returns = "T" +file = "FExMicrosoftDIServiceProvider.cs" + +[[methods]] +parent = "FExMicrosoftDIServiceProvider" +name = "GetRequiredService" +sig = "T GetRequiredService(Type serviceType)" +returns = "T" +summary = "Get service of type from the ." +file = "FExMicrosoftDIServiceProvider.cs" + +[[methods]] +parent = "FExMicrosoftDIServiceProvider" +name = "GetRequiredService" +sig = "object GetRequiredService(Type serviceType)" +returns = "object" +file = "FExMicrosoftDIServiceProvider.cs" + +[[methods]] +parent = "FExMicrosoftDIServiceProvider" +name = "GetContainer" +sig = "TContainer GetContainer() where TContainer : class" +returns = "TContainer" +file = "FExMicrosoftDIServiceProvider.cs" + +[[methods]] +parent = "FExMicrosoftDIServiceProvider" +name = "CreateScope" +sig = "IScopeProvider CreateScope()" +returns = "IScopeProvider" +file = "FExMicrosoftDIServiceProvider.cs" + +[[methods]] +parent = "FExMicrosoftDIServiceProvider" +name = "GetInstance" +sig = "T GetInstance()" +returns = "T" +file = "FExMicrosoftDIServiceProvider.cs" + +[[methods]] +parent = "FExMicrosoftDIServiceProvider" +name = "GetInstance" +sig = "object GetInstance(Type serviceType)" +returns = "object" +file = "FExMicrosoftDIServiceProvider.cs" + +[[methods]] +parent = "FExMicrosoftDIServiceProvider" +name = "GetService" +sig = "object GetService(Type serviceType)" +returns = "object" +file = "FExMicrosoftDIServiceProvider.cs" + +[[methods]] +parent = "FExMicrosoftDIServiceProvider" +name = "DisposeAsync" +sig = "ValueTask DisposeAsync()" +returns = "ValueTask" +file = "FExMicrosoftDIServiceProvider.cs" + +[[methods]] +parent = "FExMicrosoftDIServiceProvider" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "FExMicrosoftDIServiceProvider.cs" + [[classes]] name = "MicrosoftDIScopeProviderAdapter" ns = "FEx.DependencyInjection" base = "IScopeProvider" file = "FExMicrosoftDIServiceProvider.cs" +[[ctors]] +parent = "MicrosoftDIScopeProviderAdapter" +sig = "MicrosoftDIScopeProviderAdapter(IServiceProvider serviceProvider)" +file = "FExMicrosoftDIServiceProvider.cs" + +[[methods]] +parent = "MicrosoftDIScopeProviderAdapter" +name = "CreateScope" +sig = "IServiceScope CreateScope()" +returns = "IServiceScope" +file = "FExMicrosoftDIServiceProvider.cs" + [[classes]] name = "FExServiceContainer" ns = "FEx.DependencyInjection" base = "IFExServiceContainer" file = "FExServiceContainer.cs" +[[methods]] +parent = "FExServiceContainer" +name = "RegisterServices" +sig = "void RegisterServices(TContainer container, IServiceCollection services) where TContainer : class, IDisposable" +returns = "void" +file = "FExServiceContainer.cs" + +[[methods]] +parent = "FExServiceContainer" +name = "ResolveService" +sig = "T ResolveService()" +returns = "T" +file = "FExServiceContainer.cs" + +[[methods]] +parent = "FExServiceContainer" +name = "ResolveOrDefault" +sig = "T ResolveOrDefault(T fallback)" +returns = "T" +file = "FExServiceContainer.cs" + +[[methods]] +parent = "FExServiceContainer" +name = "ResolveServices" +sig = "IEnumerable ResolveServices()" +returns = "IEnumerable" +file = "FExServiceContainer.cs" + +[[methods]] +parent = "FExServiceContainer" +name = "TryResolveServices" +sig = "IEnumerable TryResolveServices()" +returns = "IEnumerable" +file = "FExServiceContainer.cs" + +[[methods]] +parent = "FExServiceContainer" +name = "ResolveServiceAsync" +sig = "Task ResolveServiceAsync()" +returns = "Task" +file = "FExServiceContainer.cs" + +[[methods]] +parent = "FExServiceContainer" +name = "ResolveServicesAsync" +sig = "Task> ResolveServicesAsync()" +returns = "Task>" +file = "FExServiceContainer.cs" + +[[methods]] +parent = "FExServiceContainer" +name = "Release" +sig = "void Release()" +returns = "void" +file = "FExServiceContainer.cs" + +[[methods]] +parent = "FExServiceContainer" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "FExServiceContainer.cs" + [[classes]] name = "FExStrongInjectServiceProvider" ns = "FEx.DependencyInjection" base = "IFExStrongInjectServiceProvider" file = "FExStrongInjectServiceProvider.cs" +[[ctors]] +parent = "FExStrongInjectServiceProvider" +sig = "FExStrongInjectServiceProvider()" +file = "FExStrongInjectServiceProvider.cs" + +[[methods]] +parent = "FExStrongInjectServiceProvider" +name = "GetRequiredService" +sig = "T GetRequiredService()" +returns = "T" +file = "FExStrongInjectServiceProvider.cs" + +[[methods]] +parent = "FExStrongInjectServiceProvider" +name = "TryResolveService" +sig = "T TryResolveService()" +returns = "T" +file = "FExStrongInjectServiceProvider.cs" + +[[methods]] +parent = "FExStrongInjectServiceProvider" +name = "GetRequiredService" +sig = "T GetRequiredService(Type serviceType)" +returns = "T" +file = "FExStrongInjectServiceProvider.cs" + +[[methods]] +parent = "FExStrongInjectServiceProvider" +name = "GetRequiredService" +sig = "object GetRequiredService(Type serviceType)" +returns = "object" +file = "FExStrongInjectServiceProvider.cs" + +[[methods]] +parent = "FExStrongInjectServiceProvider" +name = "GetContainer" +sig = "TContainer GetContainer() where TContainer : class" +returns = "TContainer" +file = "FExStrongInjectServiceProvider.cs" + +[[methods]] +parent = "FExStrongInjectServiceProvider" +name = "CreateScope" +sig = "IScopeProvider CreateScope()" +returns = "IScopeProvider" +file = "FExStrongInjectServiceProvider.cs" + +[[methods]] +parent = "FExStrongInjectServiceProvider" +name = "GetInstance" +sig = "T GetInstance()" +returns = "T" +file = "FExStrongInjectServiceProvider.cs" + +[[methods]] +parent = "FExStrongInjectServiceProvider" +name = "GetInstance" +sig = "object GetInstance(Type serviceType)" +returns = "object" +file = "FExStrongInjectServiceProvider.cs" + +[[methods]] +parent = "FExStrongInjectServiceProvider" +name = "ConfigureServiceProviderAsync" +sig = "ValueTask ConfigureServiceProviderAsync()" +returns = "ValueTask" +summary = "No-op for StrongInject provider as it doesn't need external engine configuration." +file = "FExStrongInjectServiceProvider.cs" + +[[methods]] +parent = "FExStrongInjectServiceProvider" +name = "SetServiceProvider" +sig = "void SetServiceProvider(TContainer container) where TContainer : class, IDisposable" +returns = "void" +file = "FExStrongInjectServiceProvider.cs" + +[[methods]] +parent = "FExStrongInjectServiceProvider" +name = "GetService" +sig = "object GetService(Type serviceType)" +returns = "object" +file = "FExStrongInjectServiceProvider.cs" + +[[methods]] +parent = "FExStrongInjectServiceProvider" +name = "GetRequiredServiceAsync" +sig = "Task GetRequiredServiceAsync()" +returns = "Task" +file = "FExStrongInjectServiceProvider.cs" + +[[methods]] +parent = "FExStrongInjectServiceProvider" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "FExStrongInjectServiceProvider.cs" + [[classes]] name = "ContainerExtensions" ns = "FEx.DependencyInjection.Extensions" file = "Extensions\\ContainerExtensions.cs" static = true +[[extensions]] +name = "EnsureContainerSingleton" +returns = "IServiceCollection" +sig = "IServiceCollection EnsureContainerSingleton( this IServiceCollection services, IFExServiceProvider serviceProvider)" +file = "Extensions\\ContainerExtensions.cs" + [[classes]] name = "ServiceProviderExtensions" ns = "FEx.DependencyInjection.Extensions" file = "Extensions\\ServiceProviderExtensions.cs" static = true +[[extensions]] +name = "GetService" +returns = "T" +sig = "T GetService(this IContainer serviceProvider)" +file = "Extensions\\ServiceProviderExtensions.cs" + diff --git a/.api-surface/FEx/Downloader.toml b/.api-surface/FEx/Downloader.toml index 8f35d89d..c976fec8 100644 --- a/.api-surface/FEx/Downloader.toml +++ b/.api-surface/FEx/Downloader.toml @@ -8,94 +8,1472 @@ ns = "FEx.Downloader" base = "NotifyPropertyChanged, IDownloadChunk, IDisposable" file = "DownloadChunk.cs" +[[properties]] +parent = "DownloadChunk" +name = "RangeHeader" +sig = "string RangeHeader { get; }" +returns = "string" +file = "DownloadChunk.cs" + +[[properties]] +parent = "DownloadChunk" +name = "RangeHeaderValue" +sig = "ContentRangeHeaderValue RangeHeaderValue { get; }" +returns = "ContentRangeHeaderValue" +file = "DownloadChunk.cs" + +[[properties]] +parent = "DownloadChunk" +name = "From" +sig = "long From { get; }" +returns = "long" +file = "DownloadChunk.cs" + +[[properties]] +parent = "DownloadChunk" +name = "To" +sig = "long To { get; }" +returns = "long" +file = "DownloadChunk.cs" + +[[properties]] +parent = "DownloadChunk" +name = "DirPath" +sig = "string DirPath { get; }" +returns = "string" +file = "DownloadChunk.cs" + +[[properties]] +parent = "DownloadChunk" +name = "State" +sig = "DownloadState State { get; set; }" +returns = "DownloadState" +file = "DownloadChunk.cs" + +[[properties]] +parent = "DownloadChunk" +name = "File" +sig = "FileInfo File { get; }" +returns = "FileInfo" +file = "DownloadChunk.cs" + +[[properties]] +parent = "DownloadChunk" +name = "ExpectedSize" +sig = "long ExpectedSize { get; }" +returns = "long" +file = "DownloadChunk.cs" + +[[properties]] +parent = "DownloadChunk" +name = "Size" +sig = "long Size { get; }" +returns = "long" +file = "DownloadChunk.cs" + +[[properties]] +parent = "DownloadChunk" +name = "FileStream" +sig = "FileStream FileStream { get; }" +returns = "FileStream" +file = "DownloadChunk.cs" + +[[properties]] +parent = "DownloadChunk" +name = "IsFileStreamOpen" +sig = "bool IsFileStreamOpen { get; set; }" +returns = "bool" +file = "DownloadChunk.cs" + +[[ctors]] +parent = "DownloadChunk" +sig = "DownloadChunk(long from, long to, DirectoryInfo directory, IProgress progress)" +file = "DownloadChunk.cs" + +[[ctors]] +parent = "DownloadChunk" +sig = "DownloadChunk(ContentRangeHeaderValue rangeHeader, DirectoryInfo directory, IProgress progress)" +file = "DownloadChunk.cs" + +[[ctors]] +parent = "DownloadChunk" +sig = "DownloadChunk(string rangeHeader, DirectoryInfo directory, IProgress progress)" +file = "DownloadChunk.cs" + +[[methods]] +parent = "DownloadChunk" +name = "CheckIfChunkFileIsFinished" +sig = "bool CheckIfChunkFileIsFinished()" +returns = "bool" +file = "DownloadChunk.cs" + +[[methods]] +parent = "DownloadChunk" +name = "ClearChunk" +sig = "void ClearChunk()" +returns = "void" +file = "DownloadChunk.cs" + +[[methods]] +parent = "DownloadChunk" +name = "WriteBytesAsync" +sig = "Task WriteBytesAsync(byte[] buffer, int offset, int bytesToWrite)" +returns = "Task" +file = "DownloadChunk.cs" + +[[methods]] +parent = "DownloadChunk" +name = "WriteBytesAsync" +sig = "Task WriteBytesAsync(byte[] buffer, int offset, int bytesToWrite, CancellationToken token)" +returns = "Task" +file = "DownloadChunk.cs" + +[[methods]] +parent = "DownloadChunk" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "DownloadChunk.cs" + [[classes]] name = "DownloadIndex" ns = "FEx.Downloader" base = "IEquatable" file = "DownloadIndex.cs" +[[properties]] +parent = "DownloadIndex" +name = "Url" +sig = "string Url { get; }" +returns = "string" +file = "DownloadIndex.cs" + +[[properties]] +parent = "DownloadIndex" +name = "FilePath" +sig = "string FilePath { get; }" +returns = "string" +file = "DownloadIndex.cs" + +[[ctors]] +parent = "DownloadIndex" +sig = "DownloadIndex(IDownloadBase di)" +file = "DownloadIndex.cs" + +[[methods]] +parent = "DownloadIndex" +name = "Equals" +sig = "bool Equals(DownloadIndex other)" +returns = "bool" +file = "DownloadIndex.cs" + +[[methods]] +parent = "DownloadIndex" +name = "ToString" +sig = "string ToString()" +returns = "string" +file = "DownloadIndex.cs" + +[[methods]] +parent = "DownloadIndex" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +file = "DownloadIndex.cs" + +[[methods]] +parent = "DownloadIndex" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +file = "DownloadIndex.cs" + [[classes]] name = "DownloadItem" ns = "FEx.Downloader" base = "ProgressAggregator, IDownloadItem" file = "DownloadItem.cs" +[[properties]] +parent = "DownloadItem" +name = "BufferLength" +sig = "static long BufferLength { get; }" +returns = "long" +file = "DownloadItem.cs" +static = true + +[[properties]] +parent = "DownloadItem" +name = "MD5Checksum" +sig = "string MD5Checksum { get; }" +returns = "string" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "Url" +sig = "Uri Url { get; }" +returns = "Uri" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "ReportProgress" +sig = "bool ReportProgress { get; }" +returns = "bool" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "DownloadStopwatch" +sig = "Stopwatch DownloadStopwatch { get; }" +returns = "Stopwatch" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "Pars" +sig = "WebRequestParams Pars { get; }" +returns = "WebRequestParams" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "Semaphore" +sig = "SemaphoreSlim Semaphore { get; }" +returns = "SemaphoreSlim" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "TotalSemaphore" +sig = "SemaphoreSlim TotalSemaphore { get; }" +returns = "SemaphoreSlim" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "CancellationTokenSource" +sig = "CancellationTokenSource CancellationTokenSource { get; }" +returns = "CancellationTokenSource" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "DownloadFileTask" +sig = "Task DownloadFileTask { get; set; }" +returns = "Task" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "IsSpeededUp" +sig = "bool IsSpeededUp { get; set; }" +returns = "bool" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "ParallelRanges" +sig = "int ParallelRanges { get; }" +returns = "int" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "Response" +sig = "WebResponse Response { get; set; }" +returns = "WebResponse" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "TempDirectory" +sig = "DirectoryInfo TempDirectory { get; set; }" +returns = "DirectoryInfo" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "OmitQuery" +sig = "bool OmitQuery { get; set; }" +returns = "bool" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "File" +sig = "FileInfo File { get; set; }" +returns = "FileInfo" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "FilePath" +sig = "string FilePath { get; set; }" +returns = "string" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "FileNameWithoutExtension" +sig = "string FileNameWithoutExtension { get; set; }" +returns = "string" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "FileName" +sig = "string FileName { get; set; }" +returns = "string" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "DirPath" +sig = "string DirPath { get; set; }" +returns = "string" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "Ping" +sig = "long Ping { get; }" +returns = "long" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "RunningTasks" +sig = "string RunningTasks { get; set; }" +returns = "string" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "IsDownloaded" +sig = "bool IsDownloaded { get; }" +returns = "bool" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "TargetIsNotCreated" +sig = "bool TargetIsNotCreated { get; set; }" +returns = "bool" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "DState" +sig = "DownloadState DState { get; set; }" +returns = "DownloadState" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "IsFinished" +sig = "bool IsFinished { get; }" +returns = "bool" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "DataLength" +sig = "long DataLength { get; }" +returns = "long" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "TotalPrg" +sig = "double TotalPrg { get; }" +returns = "double" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "ElapsedTime" +sig = "string ElapsedTime { get; set; }" +returns = "string" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "ElapsedMiliseconds" +sig = "long ElapsedMiliseconds { get; set; }" +returns = "long" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "IsRunning" +sig = "bool IsRunning { get; set; }" +returns = "bool" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "MaxOpenConnections" +sig = "int MaxOpenConnections { get; }" +returns = "int" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "Prg" +sig = "IProgress Prg { get; }" +returns = "IProgress" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "ConnPrg" +sig = "IProgress ConnPrg { get; }" +returns = "IProgress" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "Ranges" +sig = "Dictionary Ranges { get; }" +returns = "Dictionary" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "OpenConnections" +sig = "int OpenConnections { get; set; }" +returns = "int" +file = "DownloadItem.cs" + +[[properties]] +parent = "DownloadItem" +name = "CancellationToken" +sig = "CancellationToken CancellationToken { get; }" +returns = "CancellationToken" +file = "DownloadItem.cs" + +[[methods]] +parent = "DownloadItem" +name = "CancelAsync" +sig = "Task CancelAsync()" +returns = "Task" +file = "DownloadItem.cs" + +[[methods]] +parent = "DownloadItem" +name = "StartDownload" +sig = "void StartDownload()" +returns = "void" +file = "DownloadItem.cs" + +[[methods]] +parent = "DownloadItem" +name = "DownloadFileAsync" +sig = "Task DownloadFileAsync()" +returns = "Task" +file = "DownloadItem.cs" + +[[methods]] +parent = "DownloadItem" +name = "CreateAsync" +sig = "static Task CreateAsync(IDownloadStub downloadItem, bool reportProgress)" +returns = "Task" +file = "DownloadItem.cs" +static = true + +[[methods]] +parent = "DownloadItem" +name = "CreateAsync" +sig = "static Task CreateAsync(IDownloadStub downloadItem, bool reportProgress, CancellationToken cancellationToken)" +returns = "Task" +file = "DownloadItem.cs" +static = true + +[[methods]] +parent = "DownloadItem" +name = "CreateAsync" +sig = "static Task CreateAsync(string url, string path, bool reportProgress)" +returns = "Task" +file = "DownloadItem.cs" +static = true + +[[methods]] +parent = "DownloadItem" +name = "CreateAsync" +sig = "static Task CreateAsync(string url, string path, bool reportProgress, WebRequestParams pars, int parallelChunks, long dataLength, string md5Checksum, CancellationToken cancellationToken)" +returns = "Task" +file = "DownloadItem.cs" +static = true + +[[methods]] +parent = "DownloadItem" +name = "CreateAsync" +sig = "static Task CreateAsync(Uri url, string path, bool reportProgress)" +returns = "Task" +file = "DownloadItem.cs" +static = true + +[[methods]] +parent = "DownloadItem" +name = "CreateAsync" +sig = "static Task CreateAsync(Uri url, string path, bool reportProgress, WebRequestParams pars, int parallelChunks, long dataLength, string md5Checksum, CancellationToken cancellationToken)" +returns = "Task" +file = "DownloadItem.cs" +static = true + +[[methods]] +parent = "DownloadItem" +name = "CreateFromResponse" +sig = "static DownloadItem CreateFromResponse(HttpWebResponse response, string filePath, bool reportProgress)" +returns = "DownloadItem" +file = "DownloadItem.cs" +static = true + +[[methods]] +parent = "DownloadItem" +name = "CreateFromResponse" +sig = "static DownloadItem CreateFromResponse(HttpWebResponse response, string filePath, bool reportProgress, WebRequestParams pars, long ping, int parallelChunks, string md5Checksum, CancellationToken cancellationToken)" +returns = "DownloadItem" +file = "DownloadItem.cs" +static = true + +[[methods]] +parent = "DownloadItem" +name = "SetTemporaryCacheDirectory" +sig = "void SetTemporaryCacheDirectory(string path)" +returns = "void" +file = "DownloadItem.cs" + +[[methods]] +parent = "DownloadItem" +name = "TimerCallback" +sig = "void TimerCallback()" +returns = "void" +file = "DownloadItem.cs" + +[[methods]] +parent = "DownloadItem" +name = "GetResponseAsync" +sig = "Task GetResponseAsync()" +returns = "Task" +file = "DownloadItem.cs" + +[[methods]] +parent = "DownloadItem" +name = "HandleConnected" +sig = "void HandleConnected(bool isConnected)" +returns = "void" +file = "DownloadItem.cs" + +[[methods]] +parent = "DownloadItem" +name = "AddTotalPrgAsync" +sig = "Task AddTotalPrgAsync(double addedValue)" +returns = "Task" +file = "DownloadItem.cs" + +[[methods]] +parent = "DownloadItem" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +file = "DownloadItem.cs" + +[[methods]] +parent = "DownloadItem" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +file = "DownloadItem.cs" + +[[methods]] +parent = "DownloadItem" +name = "Equals" +sig = "bool Equals(IDownloadBase other)" +returns = "bool" +file = "DownloadItem.cs" + +[[methods]] +parent = "DownloadItem" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +file = "DownloadItem.cs" + +[[methods]] +parent = "DownloadItem" +name = "CompareTo" +sig = "int CompareTo(object obj)" +returns = "int" +file = "DownloadItem.cs" + +[[methods]] +parent = "DownloadItem" +name = "CompareTo" +sig = "int CompareTo(IDownloadBase other)" +returns = "int" +file = "DownloadItem.cs" + [[classes]] name = "DownloadRange" ns = "FEx.Downloader" base = "NotifyPropertyChanged, IDownloadRange, IDisposable" file = "DownloadRange.cs" +[[properties]] +parent = "DownloadRange" +name = "BufferSize" +sig = "static int BufferSize { get; }" +returns = "int" +file = "DownloadRange.cs" +static = true + +[[properties]] +parent = "DownloadRange" +name = "MaxChunkSize" +sig = "long MaxChunkSize { get; }" +returns = "long" +file = "DownloadRange.cs" + +[[properties]] +parent = "DownloadRange" +name = "ExpectedSize" +sig = "long ExpectedSize { get; }" +returns = "long" +file = "DownloadRange.cs" + +[[properties]] +parent = "DownloadRange" +name = "From" +sig = "long From { get; }" +returns = "long" +file = "DownloadRange.cs" + +[[properties]] +parent = "DownloadRange" +name = "To" +sig = "long To { get; }" +returns = "long" +file = "DownloadRange.cs" + +[[properties]] +parent = "DownloadRange" +name = "FilePath" +sig = "string FilePath { get; }" +returns = "string" +file = "DownloadRange.cs" + +[[properties]] +parent = "DownloadRange" +name = "ConnPrg" +sig = "IProgress ConnPrg { get; }" +returns = "IProgress" +file = "DownloadRange.cs" + +[[properties]] +parent = "DownloadRange" +name = "DataLength" +sig = "long DataLength { get; }" +returns = "long" +file = "DownloadRange.cs" + +[[properties]] +parent = "DownloadRange" +name = "Dir" +sig = "DirectoryInfo Dir { get; }" +returns = "DirectoryInfo" +file = "DownloadRange.cs" + +[[properties]] +parent = "DownloadRange" +name = "DState" +sig = "DownloadState DState { get; set; }" +returns = "DownloadState" +file = "DownloadRange.cs" + +[[properties]] +parent = "DownloadRange" +name = "Pars" +sig = "WebRequestParams Pars { get; }" +returns = "WebRequestParams" +file = "DownloadRange.cs" + +[[properties]] +parent = "DownloadRange" +name = "Url" +sig = "Uri Url { get; }" +returns = "Uri" +file = "DownloadRange.cs" + +[[properties]] +parent = "DownloadRange" +name = "Chunks" +sig = "Dictionary Chunks { get; }" +returns = "Dictionary" +file = "DownloadRange.cs" + +[[properties]] +parent = "DownloadRange" +name = "RangeHeader" +sig = "string RangeHeader { get; }" +returns = "string" +file = "DownloadRange.cs" + +[[properties]] +parent = "DownloadRange" +name = "RangeHeaderValue" +sig = "ContentRangeHeaderValue RangeHeaderValue { get; }" +returns = "ContentRangeHeaderValue" +file = "DownloadRange.cs" + +[[properties]] +parent = "DownloadRange" +name = "DirPath" +sig = "string DirPath { get; }" +returns = "string" +file = "DownloadRange.cs" + +[[properties]] +parent = "DownloadRange" +name = "Size" +sig = "long Size { get; }" +returns = "long" +file = "DownloadRange.cs" + +[[properties]] +parent = "DownloadRange" +name = "IsConnected" +sig = "bool IsConnected { get; }" +returns = "bool" +file = "DownloadRange.cs" + +[[ctors]] +parent = "DownloadRange" +sig = "DownloadRange(long from, long to, DirectoryInfo directory, Uri url, WebRequestParams pars, long maxChunkSize, string filePath, long dataLength)" +file = "DownloadRange.cs" + +[[ctors]] +parent = "DownloadRange" +sig = "DownloadRange(long from, long to, DirectoryInfo directory, Uri url, WebRequestParams pars, long maxChunkSize, string filePath, long dataLength, IProgress progress, IProgress connPrg, CancellationToken token)" +file = "DownloadRange.cs" + +[[methods]] +parent = "DownloadRange" +name = "DoDownloadAsync" +sig = "Task DoDownloadAsync(int retryCount)" +returns = "Task" +file = "DownloadRange.cs" + +[[methods]] +parent = "DownloadRange" +name = "SetContentRange" +sig = "void SetContentRange(string rangeHeader)" +returns = "void" +file = "DownloadRange.cs" + +[[methods]] +parent = "DownloadRange" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +file = "DownloadRange.cs" + +[[methods]] +parent = "DownloadRange" +name = "Equals" +sig = "bool Equals(IDownloadBase other)" +returns = "bool" +file = "DownloadRange.cs" + +[[methods]] +parent = "DownloadRange" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +file = "DownloadRange.cs" + +[[methods]] +parent = "DownloadRange" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "DownloadRange.cs" + +[[methods]] +parent = "DownloadRange" +name = "CompareTo" +sig = "int CompareTo(object obj)" +returns = "int" +file = "DownloadRange.cs" + +[[methods]] +parent = "DownloadRange" +name = "CompareTo" +sig = "int CompareTo(IDownloadBase other)" +returns = "int" +file = "DownloadRange.cs" + [[classes]] name = "DownloadStub" ns = "FEx.Downloader" base = "NotifyPropertyChanged, IDownloadStub" file = "DownloadStub.cs" +[[properties]] +parent = "DownloadStub" +name = "MD5Checksum" +sig = "string MD5Checksum { get; }" +returns = "string" +file = "DownloadStub.cs" + +[[properties]] +parent = "DownloadStub" +name = "Url" +sig = "Uri Url { get; }" +returns = "Uri" +file = "DownloadStub.cs" + +[[properties]] +parent = "DownloadStub" +name = "Pars" +sig = "WebRequestParams Pars { get; }" +returns = "WebRequestParams" +file = "DownloadStub.cs" + +[[properties]] +parent = "DownloadStub" +name = "ParallelRanges" +sig = "int ParallelRanges { get; }" +returns = "int" +file = "DownloadStub.cs" + +[[properties]] +parent = "DownloadStub" +name = "DState" +sig = "DownloadState DState { get; }" +returns = "DownloadState" +file = "DownloadStub.cs" + +[[properties]] +parent = "DownloadStub" +name = "FilePath" +sig = "string FilePath { get; set; }" +returns = "string" +file = "DownloadStub.cs" + +[[properties]] +parent = "DownloadStub" +name = "DirPath" +sig = "string DirPath { get; set; }" +returns = "string" +file = "DownloadStub.cs" + +[[properties]] +parent = "DownloadStub" +name = "DataLength" +sig = "long DataLength { get; set; }" +returns = "long" +file = "DownloadStub.cs" + +[[ctors]] +parent = "DownloadStub" +sig = "DownloadStub()" +file = "DownloadStub.cs" + +[[ctors]] +parent = "DownloadStub" +sig = "DownloadStub(string url, string filePath)" +file = "DownloadStub.cs" + +[[ctors]] +parent = "DownloadStub" +sig = "DownloadStub(string url, string filePath, string md5Checksum, WebRequestParams pars, int parallelChunks)" +file = "DownloadStub.cs" + +[[ctors]] +parent = "DownloadStub" +sig = "DownloadStub(IDownloadStub downloadItem)" +file = "DownloadStub.cs" + +[[ctors]] +parent = "DownloadStub" +sig = "DownloadStub(Uri url, string filePath)" +file = "DownloadStub.cs" + +[[ctors]] +parent = "DownloadStub" +sig = "DownloadStub(Uri url, string filePath, string md5Checksum, WebRequestParams pars, int parallelChunks)" +file = "DownloadStub.cs" + +[[methods]] +parent = "DownloadStub" +name = "UpdateInstance" +sig = "void UpdateInstance(IDownloadItem item)" +returns = "void" +file = "DownloadStub.cs" + +[[methods]] +parent = "DownloadStub" +name = "LoadTargetFileNameAsync" +sig = "Task LoadTargetFileNameAsync()" +returns = "Task" +file = "DownloadStub.cs" + +[[methods]] +parent = "DownloadStub" +name = "LoadTargetFileNameAsync" +sig = "Task LoadTargetFileNameAsync(string dirPath, string fallback)" +returns = "Task" +file = "DownloadStub.cs" + +[[methods]] +parent = "DownloadStub" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +file = "DownloadStub.cs" + +[[methods]] +parent = "DownloadStub" +name = "Equals" +sig = "bool Equals(IDownloadBase other)" +returns = "bool" +file = "DownloadStub.cs" + +[[methods]] +parent = "DownloadStub" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +file = "DownloadStub.cs" + +[[methods]] +parent = "DownloadStub" +name = "CompareTo" +sig = "int CompareTo(object obj)" +returns = "int" +file = "DownloadStub.cs" + +[[methods]] +parent = "DownloadStub" +name = "CompareTo" +sig = "int CompareTo(IDownloadBase other)" +returns = "int" +file = "DownloadStub.cs" + [[classes]] name = "FExDownloader" ns = "FEx.Downloader" base = "FExInitializable" file = "FExDownloader.cs" +[[methods]] +parent = "FExDownloader" +name = "OnInitialize" +sig = "void OnInitialize()" +returns = "void" +file = "FExDownloader.cs" + [[classes]] name = "FExDownloaderModule" ns = "FEx.Downloader" base = "InitializeModule" file = "FExDownloaderModule.cs" +[[methods]] +parent = "FExDownloaderModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExDownloaderModule container, IServiceCollection services)" +returns = "void" +file = "FExDownloaderModule.cs" + [[interfaces]] name = "IFExDownloaderModule" ns = "FEx.Downloader" +base = "IContainer, IContainer" file = "IFExDownloaderModule.cs" -[[interfaces]] -name = "IDownloadBase" -ns = "FEx.Downloader.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IDownloadBase.cs" +[[classes]] +name = "FlakHttpClient" +ns = "FEx.Downloader.Clients" +base = "ProgressAggregator, IDownloadBase" +file = "Clients\\FlakHttpClient.cs" + +[[properties]] +parent = "FlakHttpClient" +name = "FilePath" +sig = "string FilePath { get; }" +returns = "string" +file = "Clients\\FlakHttpClient.cs" + +[[properties]] +parent = "FlakHttpClient" +name = "Url" +sig = "Uri Url { get; }" +returns = "Uri" +file = "Clients\\FlakHttpClient.cs" + +[[properties]] +parent = "FlakHttpClient" +name = "DirPath" +sig = "string DirPath { get; }" +returns = "string" +file = "Clients\\FlakHttpClient.cs" + +[[properties]] +parent = "FlakHttpClient" +name = "DState" +sig = "DownloadState DState { get; }" +returns = "DownloadState" +file = "Clients\\FlakHttpClient.cs" + +[[properties]] +parent = "FlakHttpClient" +name = "Pars" +sig = "WebRequestParams Pars { get; set; }" +returns = "WebRequestParams" +file = "Clients\\FlakHttpClient.cs" + +[[properties]] +parent = "FlakHttpClient" +name = "Client" +sig = "HttpClientEx Client { get; }" +returns = "HttpClientEx" +file = "Clients\\FlakHttpClient.cs" + +[[ctors]] +parent = "FlakHttpClient" +sig = "FlakHttpClient()" +summary = "Initializes a new instance of the class with a specific handler." +file = "Clients\\FlakHttpClient.cs" + +[[ctors]] +parent = "FlakHttpClient" +sig = "FlakHttpClient(WebRequestParams pars)" +file = "Clients\\FlakHttpClient.cs" + +[[ctors]] +parent = "FlakHttpClient" +sig = "FlakHttpClient(WebRequestParams pars, bool disposeHandler)" +file = "Clients\\FlakHttpClient.cs" + +[[ctors]] +parent = "FlakHttpClient" +sig = "FlakHttpClient(WebRequestParams pars, bool disposeHandler, CancellationTokenSource cancellationTokenSource)" +file = "Clients\\FlakHttpClient.cs" + +[[ctors]] +parent = "FlakHttpClient" +sig = "FlakHttpClient(HttpClientHandler handler)" +summary = "Initializes a new instance of the class with a specific handler." +file = "Clients\\FlakHttpClient.cs" + +[[ctors]] +parent = "FlakHttpClient" +sig = "FlakHttpClient(HttpClientHandler handler, bool disposeHandler)" +file = "Clients\\FlakHttpClient.cs" + +[[ctors]] +parent = "FlakHttpClient" +sig = "FlakHttpClient(HttpClientHandler handler, bool disposeHandler, CancellationTokenSource cancellationTokenSource)" +file = "Clients\\FlakHttpClient.cs" + +[[methods]] +parent = "FlakHttpClient" +name = "CompareTo" +sig = "int CompareTo(object obj)" +returns = "int" +file = "Clients\\FlakHttpClient.cs" + +[[methods]] +parent = "FlakHttpClient" +name = "CompareTo" +sig = "int CompareTo(IDownloadBase other)" +returns = "int" +file = "Clients\\FlakHttpClient.cs" + +[[methods]] +parent = "FlakHttpClient" +name = "Equals" +sig = "bool Equals(IDownloadBase other)" +returns = "bool" +file = "Clients\\FlakHttpClient.cs" + +[[methods]] +parent = "FlakHttpClient" +name = "DelayAsync" +sig = "Task DelayAsync()" +returns = "Task" +file = "Clients\\FlakHttpClient.cs" + +[[methods]] +parent = "FlakHttpClient" +name = "DoDownloadAsync" +sig = "Task DoDownloadAsync(string filePath, HttpResponseMessage response)" +returns = "Task" +file = "Clients\\FlakHttpClient.cs" + +[[methods]] +parent = "FlakHttpClient" +name = "DoDownloadAsync" +sig = "Task DoDownloadAsync(string filePath, HttpResponseMessage response, bool lockOnFilePath)" +returns = "Task" +file = "Clients\\FlakHttpClient.cs" + +[[methods]] +parent = "FlakHttpClient" +name = "GetAsync" +sig = "Task GetAsync(Uri requestUri, HttpCompletionOption completionOption, CancellationToken cancellationToken)" +returns = "Task" +file = "Clients\\FlakHttpClient.cs" + +[[methods]] +parent = "FlakHttpClient" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +file = "Clients\\FlakHttpClient.cs" + +[[classes]] +name = "FlakWebClient" +ns = "FEx.Downloader.Clients" +base = "WebClient" +summary = "An extended WebClient that i.e. will store authentication cookie information and persist it through subsequent requests." +file = "Clients\\FlakWebClient.cs" + +[[properties]] +parent = "FlakWebClient" +name = "Unreachable" +sig = "static List Unreachable { get; }" +returns = "List" +file = "Clients\\FlakWebClient.cs" +static = true + +[[properties]] +parent = "FlakWebClient" +name = "Pars" +sig = "WebRequestParams Pars { get; }" +returns = "WebRequestParams" +file = "Clients\\FlakWebClient.cs" + +[[properties]] +parent = "FlakWebClient" +name = "ProgressInfo" +sig = "NotifyProgressInfoChanged ProgressInfo { get; }" +returns = "NotifyProgressInfoChanged" +file = "Clients\\FlakWebClient.cs" + +[[properties]] +parent = "FlakWebClient" +name = "StatusCode" +sig = "HttpStatusCode StatusCode { get; }" +returns = "HttpStatusCode" +file = "Clients\\FlakWebClient.cs" + +[[properties]] +parent = "FlakWebClient" +name = "HeadOnly" +sig = "bool HeadOnly { get; set; }" +returns = "bool" +file = "Clients\\FlakWebClient.cs" + +[[properties]] +parent = "FlakWebClient" +name = "ResponseUri" +sig = "Uri ResponseUri { get; }" +returns = "Uri" +file = "Clients\\FlakWebClient.cs" + +[[properties]] +parent = "FlakWebClient" +name = "RequestUri" +sig = "Uri RequestUri { get; }" +returns = "Uri" +file = "Clients\\FlakWebClient.cs" + +[[properties]] +parent = "FlakWebClient" +name = "DownloadedFileAddress" +sig = "Uri DownloadedFileAddress { get; }" +returns = "Uri" +file = "Clients\\FlakWebClient.cs" + +[[ctors]] +parent = "FlakWebClient" +sig = "FlakWebClient()" +file = "Clients\\FlakWebClient.cs" + +[[ctors]] +parent = "FlakWebClient" +sig = "FlakWebClient(WebRequestParams pars)" +file = "Clients\\FlakWebClient.cs" + +[[ctors]] +parent = "FlakWebClient" +sig = "FlakWebClient(WebRequestParams pars, Action downloadProgressHandler)" +file = "Clients\\FlakWebClient.cs" + +[[methods]] +parent = "FlakWebClient" +name = "CookieMonster" +sig = "List CookieMonster()" +returns = "List" +summary = "Returns list of cookies." +file = "Clients\\FlakWebClient.cs" + +[[methods]] +parent = "FlakWebClient" +name = "DownloadFileWithProgressAsync" +sig = "Task DownloadFileWithProgressAsync(Uri address, string filePath)" +returns = "Task" +file = "Clients\\FlakWebClient.cs" + +[[methods]] +parent = "FlakWebClient" +name = "DownloadFileWithProgressAsync" +sig = "Task DownloadFileWithProgressAsync(string address, string filePath)" +returns = "Task" +file = "Clients\\FlakWebClient.cs" + +[[methods]] +parent = "FlakWebClient" +name = "GetWebResponse" +sig = "WebResponse GetWebResponse(WebRequest request)" +returns = "WebResponse" +file = "Clients\\FlakWebClient.cs" + +[[methods]] +parent = "FlakWebClient" +name = "GetWebResponse" +sig = "WebResponse GetWebResponse(WebRequest request, IAsyncResult result)" +returns = "WebResponse" +file = "Clients\\FlakWebClient.cs" + +[[methods]] +parent = "FlakWebClient" +name = "GetWebRequest" +sig = "WebRequest GetWebRequest(Uri address)" +returns = "WebRequest" +file = "Clients\\FlakWebClient.cs" + +[[methods]] +parent = "FlakWebClient" +name = "OnDownloadProgressChanged" +sig = "void OnDownloadProgressChanged(DownloadProgressChangedEventArgs e)" +returns = "void" +file = "Clients\\FlakWebClient.cs" + +[[classes]] +name = "HttpClientEx" +ns = "FEx.Downloader.Clients" +base = "HttpClient, INotifyPropertyChanged, IDownloadBase" +file = "Clients\\HttpClientEx.cs" + +[[properties]] +parent = "HttpClientEx" +name = "CancellationTokenSource" +sig = "CancellationTokenSource CancellationTokenSource { get; }" +returns = "CancellationTokenSource" +file = "Clients\\HttpClientEx.cs" + +[[properties]] +parent = "HttpClientEx" +name = "Pars" +sig = "WebRequestParams Pars { get; set; }" +returns = "WebRequestParams" +file = "Clients\\HttpClientEx.cs" + +[[properties]] +parent = "HttpClientEx" +name = "FilePath" +sig = "string FilePath { get; set; }" +returns = "string" +file = "Clients\\HttpClientEx.cs" + +[[properties]] +parent = "HttpClientEx" +name = "Url" +sig = "Uri Url { get; set; }" +returns = "Uri" +file = "Clients\\HttpClientEx.cs" + +[[properties]] +parent = "HttpClientEx" +name = "DirPath" +sig = "string DirPath { get; set; }" +returns = "string" +file = "Clients\\HttpClientEx.cs" + +[[properties]] +parent = "HttpClientEx" +name = "DState" +sig = "DownloadState DState { get; set; }" +returns = "DownloadState" +file = "Clients\\HttpClientEx.cs" + +[[properties]] +parent = "HttpClientEx" +name = "IsDownloaded" +sig = "bool IsDownloaded { get; }" +returns = "bool" +file = "Clients\\HttpClientEx.cs" + +[[properties]] +parent = "HttpClientEx" +name = "IsRunning" +sig = "bool IsRunning { get; set; }" +returns = "bool" +file = "Clients\\HttpClientEx.cs" + +[[properties]] +parent = "HttpClientEx" +name = "ProgressValue" +sig = "double ProgressValue { get; set; }" +returns = "double" +file = "Clients\\HttpClientEx.cs" + +[[properties]] +parent = "HttpClientEx" +name = "ProgressMaximum" +sig = "double ProgressMaximum { get; set; }" +returns = "double" +file = "Clients\\HttpClientEx.cs" + +[[properties]] +parent = "HttpClientEx" +name = "Buffer" +sig = "byte[] Buffer { get; }" +returns = "byte[]" +file = "Clients\\HttpClientEx.cs" + +[[ctors]] +parent = "HttpClientEx" +sig = "HttpClientEx()" +summary = "Initializes a new instance of the class with a specific handler." +file = "Clients\\HttpClientEx.cs" + +[[ctors]] +parent = "HttpClientEx" +sig = "HttpClientEx(WebRequestParams pars)" +file = "Clients\\HttpClientEx.cs" + +[[ctors]] +parent = "HttpClientEx" +sig = "HttpClientEx(WebRequestParams pars, bool disposeHandler)" +file = "Clients\\HttpClientEx.cs" + +[[ctors]] +parent = "HttpClientEx" +sig = "HttpClientEx(WebRequestParams pars, bool disposeHandler, CancellationTokenSource cancellationTokenSource)" +file = "Clients\\HttpClientEx.cs" + +[[ctors]] +parent = "HttpClientEx" +sig = "HttpClientEx(HttpClientHandler handler)" +summary = "Initializes a new instance of the class with a specific handler." +file = "Clients\\HttpClientEx.cs" + +[[ctors]] +parent = "HttpClientEx" +sig = "HttpClientEx(HttpClientHandler handler, bool disposeHandler)" +file = "Clients\\HttpClientEx.cs" + +[[ctors]] +parent = "HttpClientEx" +sig = "HttpClientEx(HttpClientHandler handler, bool disposeHandler, CancellationTokenSource cancellationTokenSource)" +file = "Clients\\HttpClientEx.cs" + +[[methods]] +parent = "HttpClientEx" +name = "CompareTo" +sig = "int CompareTo(object obj)" +returns = "int" +file = "Clients\\HttpClientEx.cs" + +[[methods]] +parent = "HttpClientEx" +name = "CompareTo" +sig = "int CompareTo(IDownloadBase other)" +returns = "int" +file = "Clients\\HttpClientEx.cs" + +[[methods]] +parent = "HttpClientEx" +name = "Equals" +sig = "bool Equals(IDownloadBase other)" +returns = "bool" +file = "Clients\\HttpClientEx.cs" + +[[methods]] +parent = "HttpClientEx" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +file = "Clients\\HttpClientEx.cs" -[[interfaces]] -name = "IDownloadChunk" -ns = "FEx.Downloader.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IDownloadChunk.cs" +[[methods]] +parent = "HttpClientEx" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +file = "Clients\\HttpClientEx.cs" -[[interfaces]] -name = "IDownloadItem" -ns = "FEx.Downloader.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IDownloadItem.cs" +[[methods]] +parent = "HttpClientEx" +name = "DownloadFileAsync" +sig = "Task DownloadFileAsync(Uri url, string filePath)" +returns = "Task" +file = "Clients\\HttpClientEx.cs" -[[interfaces]] -name = "IDownloadPart" -ns = "FEx.Downloader.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IDownloadPart.cs" +[[methods]] +parent = "HttpClientEx" +name = "DownloadFileAsync" +sig = "Task DownloadFileAsync(Uri url, string filePath, bool lockOnFilePath)" +returns = "Task" +file = "Clients\\HttpClientEx.cs" -[[interfaces]] -name = "IDownloadRange" -ns = "FEx.Downloader.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IDownloadRange.cs" +[[methods]] +parent = "HttpClientEx" +name = "DoDownloadAsync" +sig = "Task DoDownloadAsync(string filePath, HttpResponseMessage response)" +returns = "Task" +file = "Clients\\HttpClientEx.cs" -[[interfaces]] -name = "IDownloadStub" -ns = "FEx.Downloader.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IDownloadStub.cs" +[[methods]] +parent = "HttpClientEx" +name = "DoDownloadAsync" +sig = "Task DoDownloadAsync(string filePath, HttpResponseMessage response, bool lockOnFilePath)" +returns = "Task" +file = "Clients\\HttpClientEx.cs" -[[classes]] -name = "FlakHttpClient" -ns = "FEx.Downloader.Clients" -base = "ProgressAggregator, IDownloadBase" -file = "Clients\\FlakHttpClient.cs" +[[methods]] +parent = "HttpClientEx" +name = "DelayAsync" +sig = "Task DelayAsync()" +returns = "Task" +file = "Clients\\HttpClientEx.cs" -[[classes]] -name = "FlakWebClient" -ns = "FEx.Downloader.Clients" -base = "WebClient" -summary = "An extended WebClient that i.e. will store authentication cookie information and persist it through subsequent requests." -file = "Clients\\FlakWebClient.cs" +[[methods]] +parent = "HttpClientEx" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +file = "Clients\\HttpClientEx.cs" -[[classes]] -name = "HttpClientEx" -ns = "FEx.Downloader.Clients" -base = "HttpClient, INotifyPropertyChanged, IDownloadBase" +[[methods]] +parent = "HttpClientEx" +name = "OnPropertyChanged" +sig = "void OnPropertyChanged([CallerMemberName] string propertyName = null)" +returns = "void" +file = "Clients\\HttpClientEx.cs" + +[[methods]] +parent = "HttpClientEx" +name = "SetProperty" +sig = "bool SetProperty(ref TRet backingField, TRet newValue, Action onPropertyChanged = null, [CallerMemberName] string propertyName = null)" +returns = "bool" file = "Clients\\HttpClientEx.cs" [[enums]] @@ -111,8 +1489,8 @@ static = true [[extensions]] name = "DoDownloadAsync" -sig = "Task DoDownloadAsync(this IDownloadRange downloadRange)" returns = "Task" +sig = "Task DoDownloadAsync(this IDownloadRange downloadRange)" file = "Extensions\\DownloadRangeExtensions.cs" [[classes]] @@ -121,15 +1499,596 @@ ns = "FEx.Downloader.Models" base = "IEquatable" file = "Models\\HttpClientServiceStub.cs" +[[properties]] +parent = "HttpClientServiceStub" +name = "Host" +sig = "string Host { get; }" +returns = "string" +file = "Models\\HttpClientServiceStub.cs" + +[[properties]] +parent = "HttpClientServiceStub" +name = "Pars" +sig = "WebRequestParams Pars { get; set; }" +returns = "WebRequestParams" +file = "Models\\HttpClientServiceStub.cs" + +[[properties]] +parent = "HttpClientServiceStub" +name = "HttpClientsCount" +sig = "int HttpClientsCount { get; set; }" +returns = "int" +file = "Models\\HttpClientServiceStub.cs" + +[[ctors]] +parent = "HttpClientServiceStub" +sig = "HttpClientServiceStub(Uri url, WebRequestParams pars = null, int clientsCount = 2)" +file = "Models\\HttpClientServiceStub.cs" + +[[ctors]] +parent = "HttpClientServiceStub" +sig = "HttpClientServiceStub(string urlHost, WebRequestParams pars = null, int clientsCount = 2)" +file = "Models\\HttpClientServiceStub.cs" + +[[methods]] +parent = "HttpClientServiceStub" +name = "Equals" +sig = "bool Equals(HttpClientServiceStub other)" +returns = "bool" +file = "Models\\HttpClientServiceStub.cs" + +[[methods]] +parent = "HttpClientServiceStub" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +file = "Models\\HttpClientServiceStub.cs" + +[[methods]] +parent = "HttpClientServiceStub" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +file = "Models\\HttpClientServiceStub.cs" + [[classes]] name = "DownloadService" ns = "FEx.Downloader.Services" base = "ProgressAggregator" file = "Services\\DownloadService.cs" +[[properties]] +parent = "DownloadService" +name = "DefaultParallelDownloads" +sig = "static uint DefaultParallelDownloads { get; set; }" +returns = "uint" +file = "Services\\DownloadService.cs" +static = true + +[[properties]] +parent = "DownloadService" +name = "Subscriptions" +sig = "ConcurrentDictionary Subscriptions { get; }" +returns = "ConcurrentDictionary" +file = "Services\\DownloadService.cs" + +[[properties]] +parent = "DownloadService" +name = "Downloads" +sig = "ConcurrentObservableDictionary Downloads { get; }" +returns = "ConcurrentObservableDictionary" +file = "Services\\DownloadService.cs" + +[[properties]] +parent = "DownloadService" +name = "Queue" +sig = "AsyncProcessingQueue Queue { get; }" +returns = "AsyncProcessingQueue" +file = "Services\\DownloadService.cs" + +[[properties]] +parent = "DownloadService" +name = "IncludeFinished" +sig = "bool IncludeFinished { get; set; }" +returns = "bool" +file = "Services\\DownloadService.cs" + +[[properties]] +parent = "DownloadService" +name = "SetFinished" +sig = "bool SetFinished { get; set; }" +returns = "bool" +file = "Services\\DownloadService.cs" + +[[properties]] +parent = "DownloadService" +name = "CalculateTotalProgress" +sig = "bool CalculateTotalProgress { get; set; }" +returns = "bool" +file = "Services\\DownloadService.cs" + +[[properties]] +parent = "DownloadService" +name = "ParallelDownloads" +sig = "uint ParallelDownloads { get; set; }" +returns = "uint" +file = "Services\\DownloadService.cs" + +[[ctors]] +parent = "DownloadService" +sig = "DownloadService()" +file = "Services\\DownloadService.cs" + +[[methods]] +parent = "DownloadService" +name = "AddDownloadStubAsync" +sig = "Task AddDownloadStubAsync(IDownloadStub stub)" +returns = "Task" +file = "Services\\DownloadService.cs" + +[[methods]] +parent = "DownloadService" +name = "AddDownloadStubAsync" +sig = "Task AddDownloadStubAsync(IDownloadStub stub, bool cancelAndReplaceOldOne, bool startDownload)" +returns = "Task" +file = "Services\\DownloadService.cs" + +[[methods]] +parent = "DownloadService" +name = "AddDownloadAsync" +sig = "Task AddDownloadAsync(IDownloadItem di, bool cancelAndReplaceOldOne = true, bool startDownload = true)" +returns = "Task" +file = "Services\\DownloadService.cs" + +[[methods]] +parent = "DownloadService" +name = "StartDownloads" +sig = "void StartDownloads()" +returns = "void" +file = "Services\\DownloadService.cs" + +[[methods]] +parent = "DownloadService" +name = "WaitForAllDownloadsAsync" +sig = "Task WaitForAllDownloadsAsync()" +returns = "Task" +file = "Services\\DownloadService.cs" + +[[methods]] +parent = "DownloadService" +name = "AddDownloadAsync" +sig = "Task AddDownloadAsync(IDownloadItem di, DownloadIndex idx, bool cancelAndReplaceOldOne = true, bool startDownload = true)" +returns = "Task" +file = "Services\\DownloadService.cs" + [[classes]] name = "HttpClientService" ns = "FEx.Downloader.Services" base = "IDisposable" file = "Services\\HttpClientService.cs" +[[properties]] +parent = "HttpClientService" +name = "Host" +sig = "string Host { get; }" +returns = "string" +file = "Services\\HttpClientService.cs" + +[[properties]] +parent = "HttpClientService" +name = "DefaultPars" +sig = "WebRequestParams DefaultPars { get; }" +returns = "WebRequestParams" +file = "Services\\HttpClientService.cs" + +[[methods]] +parent = "HttpClientService" +name = "GetInstanceAsync" +sig = "static Task GetInstanceAsync(string urlHost, WebRequestParams pars = null, int clientsCount = 2)" +returns = "Task" +file = "Services\\HttpClientService.cs" +static = true + +[[methods]] +parent = "HttpClientService" +name = "GetInstanceAsync" +sig = "static Task GetInstanceAsync(HttpClientServiceStub stub)" +returns = "Task" +file = "Services\\HttpClientService.cs" +static = true + +[[methods]] +parent = "HttpClientService" +name = "PrepareInstanceAsync" +sig = "static Task PrepareInstanceAsync(string urlHost, WebRequestParams pars = null, int clientsCount = 2)" +returns = "Task" +file = "Services\\HttpClientService.cs" +static = true + +[[methods]] +parent = "HttpClientService" +name = "PrepareInstanceAsync" +sig = "static Task PrepareInstanceAsync(HttpClientServiceStub stub)" +returns = "Task" +file = "Services\\HttpClientService.cs" +static = true + +[[methods]] +parent = "HttpClientService" +name = "RemoveInstanceAsync" +sig = "static Task RemoveInstanceAsync(string urlHost, bool waitForBusyClients = true)" +returns = "Task" +file = "Services\\HttpClientService.cs" +static = true + +[[methods]] +parent = "HttpClientService" +name = "DoHttpClientActionAsync" +sig = "Task DoHttpClientActionAsync(Action action, WebRequestParams pars = null)" +returns = "Task" +file = "Services\\HttpClientService.cs" + +[[methods]] +parent = "HttpClientService" +name = "DoHttpClientActionAsync" +sig = "Task DoHttpClientActionAsync(Func func, WebRequestParams pars = null)" +returns = "Task" +file = "Services\\HttpClientService.cs" + +[[methods]] +parent = "HttpClientService" +name = "DoHttpClientActionAsync" +sig = "Task DoHttpClientActionAsync(Func> func, WebRequestParams pars = null)" +returns = "Task" +file = "Services\\HttpClientService.cs" + +[[methods]] +parent = "HttpClientService" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Services\\HttpClientService.cs" + +[[methods]] +parent = "HttpClientService" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +file = "Services\\HttpClientService.cs" + +[[interfaces]] +name = "IDownloadBase" +ns = "FEx.Downloader.Abstractions.Interfaces" +base = "IEquatable, IComparable, IComparable" +file = "Abstractions\\Interfaces\\IDownloadBase.cs" + +[[properties]] +parent = "IDownloadBase" +name = "FilePath" +sig = "string FilePath { get; }" +returns = "string" +file = "Abstractions\\Interfaces\\IDownloadBase.cs" + +[[properties]] +parent = "IDownloadBase" +name = "Url" +sig = "Uri Url { get; }" +returns = "Uri" +file = "Abstractions\\Interfaces\\IDownloadBase.cs" + +[[properties]] +parent = "IDownloadBase" +name = "DirPath" +sig = "string DirPath { get; }" +returns = "string" +file = "Abstractions\\Interfaces\\IDownloadBase.cs" + +[[properties]] +parent = "IDownloadBase" +name = "DState" +sig = "DownloadState DState { get; }" +returns = "DownloadState" +file = "Abstractions\\Interfaces\\IDownloadBase.cs" + +[[properties]] +parent = "IDownloadBase" +name = "Pars" +sig = "WebRequestParams Pars { get; }" +returns = "WebRequestParams" +file = "Abstractions\\Interfaces\\IDownloadBase.cs" + +[[interfaces]] +name = "IDownloadChunk" +ns = "FEx.Downloader.Abstractions.Interfaces" +base = "IDownloadPart" +file = "Abstractions\\Interfaces\\IDownloadChunk.cs" + +[[properties]] +parent = "IDownloadChunk" +name = "DirPath" +sig = "string DirPath { get; }" +returns = "string" +file = "Abstractions\\Interfaces\\IDownloadChunk.cs" + +[[properties]] +parent = "IDownloadChunk" +name = "File" +sig = "FileInfo File { get; }" +returns = "FileInfo" +file = "Abstractions\\Interfaces\\IDownloadChunk.cs" + +[[properties]] +parent = "IDownloadChunk" +name = "FileStream" +sig = "FileStream FileStream { get; }" +returns = "FileStream" +file = "Abstractions\\Interfaces\\IDownloadChunk.cs" + +[[properties]] +parent = "IDownloadChunk" +name = "IsFileStreamOpen" +sig = "bool IsFileStreamOpen { get; set; }" +returns = "bool" +file = "Abstractions\\Interfaces\\IDownloadChunk.cs" + +[[properties]] +parent = "IDownloadChunk" +name = "State" +sig = "DownloadState State { get; set; }" +returns = "DownloadState" +file = "Abstractions\\Interfaces\\IDownloadChunk.cs" + +[[methods]] +parent = "IDownloadChunk" +name = "CheckIfChunkFileIsFinished" +sig = "bool CheckIfChunkFileIsFinished()" +returns = "bool" +file = "Abstractions\\Interfaces\\IDownloadChunk.cs" + +[[interfaces]] +name = "IDownloadItem" +ns = "FEx.Downloader.Abstractions.Interfaces" +base = "IDownloadStub, IDisposable, IProgressStatus" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[properties]] +parent = "IDownloadItem" +name = "CancellationTokenSource" +sig = "CancellationTokenSource CancellationTokenSource { get; }" +returns = "CancellationTokenSource" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[properties]] +parent = "IDownloadItem" +name = "DownloadFileTask" +sig = "Task DownloadFileTask { get; set; }" +returns = "Task" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[properties]] +parent = "IDownloadItem" +name = "ElapsedMiliseconds" +sig = "long ElapsedMiliseconds { get; }" +returns = "long" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[properties]] +parent = "IDownloadItem" +name = "ElapsedTime" +sig = "string ElapsedTime { get; }" +returns = "string" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[properties]] +parent = "IDownloadItem" +name = "IsDownloaded" +sig = "bool IsDownloaded { get; }" +returns = "bool" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[properties]] +parent = "IDownloadItem" +name = "IsFinished" +sig = "bool IsFinished { get; }" +returns = "bool" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[properties]] +parent = "IDownloadItem" +name = "IsRunning" +sig = "bool IsRunning { get; }" +returns = "bool" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[properties]] +parent = "IDownloadItem" +name = "OmitQuery" +sig = "bool OmitQuery { get; set; }" +returns = "bool" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[properties]] +parent = "IDownloadItem" +name = "Ping" +sig = "long Ping { get; }" +returns = "long" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[properties]] +parent = "IDownloadItem" +name = "Response" +sig = "WebResponse Response { get; }" +returns = "WebResponse" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[properties]] +parent = "IDownloadItem" +name = "RunningTasks" +sig = "string RunningTasks { get; set; }" +returns = "string" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[properties]] +parent = "IDownloadItem" +name = "TargetIsNotCreated" +sig = "bool TargetIsNotCreated { get; }" +returns = "bool" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[properties]] +parent = "IDownloadItem" +name = "Semaphore" +sig = "SemaphoreSlim Semaphore { get; }" +returns = "SemaphoreSlim" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[properties]] +parent = "IDownloadItem" +name = "TotalPrg" +sig = "double TotalPrg { get; }" +returns = "double" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[properties]] +parent = "IDownloadItem" +name = "TotalSemaphore" +sig = "SemaphoreSlim TotalSemaphore { get; }" +returns = "SemaphoreSlim" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[properties]] +parent = "IDownloadItem" +name = "FileName" +sig = "string FileName { get; set; }" +returns = "string" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[properties]] +parent = "IDownloadItem" +name = "FileNameWithoutExtension" +sig = "string FileNameWithoutExtension { get; set; }" +returns = "string" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[properties]] +parent = "IDownloadItem" +name = "File" +sig = "FileInfo File { get; }" +returns = "FileInfo" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[methods]] +parent = "IDownloadItem" +name = "CancelAsync" +sig = "Task CancelAsync()" +returns = "Task" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[methods]] +parent = "IDownloadItem" +name = "DownloadFileAsync" +sig = "Task DownloadFileAsync()" +returns = "Task" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[methods]] +parent = "IDownloadItem" +name = "StartDownload" +sig = "void StartDownload()" +returns = "void" +file = "Abstractions\\Interfaces\\IDownloadItem.cs" + +[[interfaces]] +name = "IDownloadPart" +ns = "FEx.Downloader.Abstractions.Interfaces" +file = "Abstractions\\Interfaces\\IDownloadPart.cs" + +[[properties]] +parent = "IDownloadPart" +name = "ExpectedSize" +sig = "long ExpectedSize { get; }" +returns = "long" +file = "Abstractions\\Interfaces\\IDownloadPart.cs" + +[[properties]] +parent = "IDownloadPart" +name = "From" +sig = "long From { get; }" +returns = "long" +file = "Abstractions\\Interfaces\\IDownloadPart.cs" + +[[properties]] +parent = "IDownloadPart" +name = "RangeHeader" +sig = "string RangeHeader { get; }" +returns = "string" +file = "Abstractions\\Interfaces\\IDownloadPart.cs" + +[[properties]] +parent = "IDownloadPart" +name = "RangeHeaderValue" +sig = "ContentRangeHeaderValue RangeHeaderValue { get; }" +returns = "ContentRangeHeaderValue" +file = "Abstractions\\Interfaces\\IDownloadPart.cs" + +[[properties]] +parent = "IDownloadPart" +name = "Size" +sig = "long Size { get; }" +returns = "long" +file = "Abstractions\\Interfaces\\IDownloadPart.cs" + +[[properties]] +parent = "IDownloadPart" +name = "To" +sig = "long To { get; }" +returns = "long" +file = "Abstractions\\Interfaces\\IDownloadPart.cs" + +[[interfaces]] +name = "IDownloadRange" +ns = "FEx.Downloader.Abstractions.Interfaces" +base = "IDownloadBase, IDownloadPart" +file = "Abstractions\\Interfaces\\IDownloadRange.cs" + +[[properties]] +parent = "IDownloadRange" +name = "IsConnected" +sig = "bool IsConnected { get; }" +returns = "bool" +file = "Abstractions\\Interfaces\\IDownloadRange.cs" + +[[methods]] +parent = "IDownloadRange" +name = "DoDownloadAsync" +sig = "Task DoDownloadAsync(int retryCount)" +returns = "Task" +file = "Abstractions\\Interfaces\\IDownloadRange.cs" + +[[interfaces]] +name = "IDownloadStub" +ns = "FEx.Downloader.Abstractions.Interfaces" +base = "IDownloadBase" +file = "Abstractions\\Interfaces\\IDownloadStub.cs" + +[[properties]] +parent = "IDownloadStub" +name = "MD5Checksum" +sig = "string MD5Checksum { get; }" +returns = "string" +file = "Abstractions\\Interfaces\\IDownloadStub.cs" + +[[properties]] +parent = "IDownloadStub" +name = "ParallelRanges" +sig = "int ParallelRanges { get; }" +returns = "int" +file = "Abstractions\\Interfaces\\IDownloadStub.cs" + +[[properties]] +parent = "IDownloadStub" +name = "DataLength" +sig = "long DataLength { get; }" +returns = "long" +file = "Abstractions\\Interfaces\\IDownloadStub.cs" + diff --git a/.api-surface/FEx/EFCore.toml b/.api-surface/FEx/EFCore.toml index ccd3e71e..85afb464 100644 --- a/.api-surface/FEx/EFCore.toml +++ b/.api-surface/FEx/EFCore.toml @@ -8,28 +8,396 @@ ns = "FEx.EFCore" base = "FExInitializable" file = "FExEFCore.cs" +[[ctors]] +parent = "FExEFCore" +sig = "FExEFCore(ISqlDbHelper sqlDbHelper)" +file = "FExEFCore.cs" + +[[methods]] +parent = "FExEFCore" +name = "CompleteInitializationAsync" +sig = "Task CompleteInitializationAsync()" +returns = "Task" +file = "FExEFCore.cs" + +[[methods]] +parent = "FExEFCore" +name = "OnInitialize" +sig = "void OnInitialize()" +returns = "void" +file = "FExEFCore.cs" + [[classes]] name = "FExEFCoreModule" ns = "FEx.EFCore" base = "InitializeModule" file = "FExEFCoreModule.cs" +[[methods]] +parent = "FExEFCoreModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExEFCoreModule container, IServiceCollection services)" +returns = "void" +file = "FExEFCoreModule.cs" + [[interfaces]] name = "IFExEFCoreModule" ns = "FEx.EFCore" +base = "IContainer, IContainer" file = "IFExEFCoreModule.cs" -[[classes]] -name = "IsExternalInit" -ns = "System.Runtime.CompilerServices" -file = "IsExternalInit.cs" -static = true - [[classes]] name = "SynchronizedDictionary" ns = "FEx.EFCore.Collections" -base = "AsyncInitializable, IReadOnlyCollection - where TKey : IEquatable where TValue : class, INotifyPropertyChanged where TDbCtx : DbContext" +base = "AsyncInitializable, IReadOnlyCollection" +file = "Collections\\SynchronizedDictionary.cs" + +[[properties]] +parent = "SynchronizedDictionary" +name = "Index" +sig = "ConcurrentHashSet Index { get; }" +returns = "ConcurrentHashSet" +file = "Collections\\SynchronizedDictionary.cs" + +[[properties]] +parent = "SynchronizedDictionary" +name = "UseIndex" +sig = "bool UseIndex { get; set; }" +returns = "bool" +file = "Collections\\SynchronizedDictionary.cs" + +[[properties]] +parent = "SynchronizedDictionary" +name = "Count" +sig = "int Count { get; }" +returns = "int" +file = "Collections\\SynchronizedDictionary.cs" + +[[properties]] +parent = "SynchronizedDictionary" +name = "HasCachedAll" +sig = "bool HasCachedAll { get; set; }" +returns = "bool" +file = "Collections\\SynchronizedDictionary.cs" + +[[properties]] +parent = "SynchronizedDictionary" +name = "KeyPropertyName" +sig = "string KeyPropertyName { get; }" +returns = "string" +file = "Collections\\SynchronizedDictionary.cs" + +[[properties]] +parent = "SynchronizedDictionary" +name = "Cache" +sig = "SourceCache Cache { get; }" +returns = "SourceCache" +file = "Collections\\SynchronizedDictionary.cs" + +[[properties]] +parent = "SynchronizedDictionary" +name = "CacheTasks" +sig = "ConcurrentDictionary> CacheTasks { get; }" +returns = "ConcurrentDictionary>" +file = "Collections\\SynchronizedDictionary.cs" + +[[properties]] +parent = "SynchronizedDictionary" +name = "CacheHandlerSemaphore" +sig = "SemaphoreSlim CacheHandlerSemaphore { get; }" +returns = "SemaphoreSlim" +file = "Collections\\SynchronizedDictionary.cs" + +[[ctors]] +parent = "SynchronizedDictionary" +sig = "SynchronizedDictionary(IEFCoreDatabaseBackedService dbService, // ReSharper disable UnusedParameter.Local AsyncHelper asyncHelper, // ReSharper restore UnusedParameter.Local string keyPropertyName, Func>[] observables = null, params string[] observedProperties)" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "GetEnumerator" +sig = "IEnumerator GetEnumerator()" +returns = "IEnumerator" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "GetOrAddValueAsync" +sig = "Task GetOrAddValueAsync(TKey key, bool addNew = true, IDictionary param = null)" +returns = "Task" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "CacheAllAsync" +sig = "Task CacheAllAsync(HashSet keys = null)" +returns = "Task" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "Remove" +sig = "bool Remove(TValue value)" +returns = "bool" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "Remove" +sig = "bool Remove(TKey key)" +returns = "bool" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "RemoveWhereAsync" +sig = "Task RemoveWhereAsync(Func func)" +returns = "Task" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "ForAllTaskAsync" +sig = "Task ForAllTaskAsync(Func func)" +returns = "Task" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "ForAllTaskAsync" +sig = "Task ForAllTaskAsync(Func> func)" +returns = "Task" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "ForAllFuncAsync" +sig = "Task ForAllFuncAsync(Func func)" +returns = "Task" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "ForAllAsync" +sig = "Task ForAllAsync(Action func)" +returns = "Task" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "ForAllAsync" +sig = "Task ForAllAsync(Func func)" +returns = "Task" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "ContainsKeyAsync" +sig = "Task ContainsKeyAsync(TKey key)" +returns = "Task" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "CacheIsEmptyAsync" +sig = "Task CacheIsEmptyAsync()" +returns = "Task" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "AddOrUpdateValue" +sig = "void AddOrUpdateValue(TValue value)" +returns = "void" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "EnsureKeysIndexAsync" +sig = "Task EnsureKeysIndexAsync()" +returns = "Task" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "WaitForCacheTasksAsync" +sig = "Task WaitForCacheTasksAsync()" +returns = "Task" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "RetriveKey" +sig = "Expression> RetriveKey()" +returns = "Expression>" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "DbSetAccessor" +sig = "DbSet DbSetAccessor(TDbCtx ctx)" +returns = "DbSet" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "GetNew" +sig = "TValue GetNew(TKey key, IDictionary param = null)" +returns = "TValue" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "OnChangesDetectedAsync" +sig = "Task OnChangesDetectedAsync(ICollection> changes)" +returns = "Task" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "IncludeInEntity" +sig = "IQueryable IncludeInEntity(IQueryable query)" +returns = "IQueryable" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "LoadEntityAsync" +sig = "Task LoadEntityAsync(TDbCtx ctx, TValue entity)" +returns = "Task" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "OnRemovedFromCache" +sig = "void OnRemovedFromCache(TValue removedValue)" +returns = "void" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "OnRetrievedNew" +sig = "void OnRetrievedNew(TValue value)" +returns = "void" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "OnInitializeAsync" +sig = "Task OnInitializeAsync()" +returns = "Task" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "KeyRetriver" +sig = "TKey KeyRetriver(TValue value)" +returns = "TKey" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "GetParam" +sig = "T GetParam(IDictionary param, string key)" +returns = "T" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "SaveCacheChangesAsync" +sig = "Task SaveCacheChangesAsync(TDbCtx dbContext, ICollection> changes)" +returns = "Task" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "HasKey" +sig = "Expression> HasKey(TKey key)" +returns = "Expression>" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "TryFindEntityAsync" +sig = "Task<(TValue entity, bool existsInDb)> TryFindEntityAsync(TDbCtx dbContext, TValue e)" +returns = "Task<(TValue entity, bool existsInDb)>" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "TryFindEntityAsync" +sig = "Task<(TKey key, bool existsInDb)> TryFindEntityAsync(TDbCtx dbContext, TKey key)" +returns = "Task<(TKey key, bool existsInDb)>" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "ExistsInDbAsync" +sig = "Task ExistsInDbAsync(TDbCtx dbContext, TKey key)" +returns = "Task" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "IndexContains" +sig = "bool IndexContains(TKey key)" +returns = "bool" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "KeyIsIn" +sig = "Expression> KeyIsIn(HashSet keys)" +returns = "Expression>" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "AddToIndex" +sig = "void AddToIndex(TValue v)" +returns = "void" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "AddKeyToIndex" +sig = "void AddKeyToIndex(TKey e)" +returns = "void" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "AddKeysToIndex" +sig = "void AddKeysToIndex(IEnumerable keys)" +returns = "void" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "RemoveFromIndex" +sig = "void RemoveFromIndex(TValue v)" +returns = "void" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "RemoveKeyFromIndex" +sig = "void RemoveKeyFromIndex(TKey e)" +returns = "void" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "RemoveKeysWhereFromIndex" +sig = "void RemoveKeysWhereFromIndex(Predicate match)" +returns = "void" +file = "Collections\\SynchronizedDictionary.cs" + +[[methods]] +parent = "SynchronizedDictionary" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" file = "Collections\\SynchronizedDictionary.cs" [[classes]] @@ -38,22 +406,214 @@ ns = "FEx.EFCore.Configuration" base = "IBulkDbConfig" file = "Configuration\\BulkDbConfig.cs" +[[properties]] +parent = "BulkDbConfig" +name = "Config" +sig = "Func Config { get; }" +returns = "Func" +file = "Configuration\\BulkDbConfig.cs" + +[[properties]] +parent = "BulkDbConfig" +name = "ParallelBulkOperations" +sig = "int ParallelBulkOperations { get; }" +returns = "int" +file = "Configuration\\BulkDbConfig.cs" + +[[ctors]] +parent = "BulkDbConfig" +sig = "BulkDbConfig(Func config, int parallelBulkOperations)" +file = "Configuration\\BulkDbConfig.cs" + [[classes]] name = "DbServiceConfig" ns = "FEx.EFCore.Configuration" base = "IDbServiceConfig" file = "Configuration\\DbServiceConfig.cs" +[[properties]] +parent = "DbServiceConfig" +name = "BulkDbConfig" +sig = "IBulkDbConfig BulkDbConfig { get; }" +returns = "IBulkDbConfig" +file = "Configuration\\DbServiceConfig.cs" + +[[properties]] +parent = "DbServiceConfig" +name = "DbConfig" +sig = "IFExDbConfig DbConfig { get; }" +returns = "IFExDbConfig" +file = "Configuration\\DbServiceConfig.cs" + +[[ctors]] +parent = "DbServiceConfig" +sig = "DbServiceConfig(IFExDbConfig dbConfig, IBulkDbConfig bulkDbConfig = null)" +file = "Configuration\\DbServiceConfig.cs" + +[[classes]] +name = "FExDbConfig" +ns = "FEx.EFCore.Configuration" +base = "IFExDbConfig" +file = "Configuration\\FExDbConfig.cs" + +[[properties]] +parent = "FExDbConfig" +name = "SqlInstance" +sig = "string SqlInstance { get; set; }" +returns = "string" +file = "Configuration\\FExDbConfig.cs" + +[[properties]] +parent = "FExDbConfig" +name = "SqlDbName" +sig = "string SqlDbName { get; init; }" +returns = "string" +file = "Configuration\\FExDbConfig.cs" + +[[properties]] +parent = "FExDbConfig" +name = "Username" +sig = "string Username { get; init; }" +returns = "string" +file = "Configuration\\FExDbConfig.cs" + +[[properties]] +parent = "FExDbConfig" +name = "Password" +sig = "string Password { get; init; }" +returns = "string" +file = "Configuration\\FExDbConfig.cs" + +[[properties]] +parent = "FExDbConfig" +name = "RunMigrations" +sig = "bool RunMigrations { get; set; }" +returns = "bool" +file = "Configuration\\FExDbConfig.cs" + +[[properties]] +parent = "FExDbConfig" +name = "GetMappings" +sig = "bool GetMappings { get; set; }" +returns = "bool" +file = "Configuration\\FExDbConfig.cs" + +[[properties]] +parent = "FExDbConfig" +name = "DropIfMigrationFailed" +sig = "bool DropIfMigrationFailed { get; init; }" +returns = "bool" +file = "Configuration\\FExDbConfig.cs" + +[[properties]] +parent = "FExDbConfig" +name = "DelayOnTimeout" +sig = "int DelayOnTimeout { get; init; }" +returns = "int" +file = "Configuration\\FExDbConfig.cs" + +[[properties]] +parent = "FExDbConfig" +name = "PoolSize" +sig = "int PoolSize { get; init; }" +returns = "int" +file = "Configuration\\FExDbConfig.cs" + +[[properties]] +parent = "FExDbConfig" +name = "SqliteDbFile" +sig = "FileInfo SqliteDbFile { get; init; }" +returns = "FileInfo" +file = "Configuration\\FExDbConfig.cs" + +[[properties]] +parent = "FExDbConfig" +name = "UseSqlite" +sig = "bool UseSqlite { get; init; }" +returns = "bool" +file = "Configuration\\FExDbConfig.cs" + +[[properties]] +parent = "FExDbConfig" +name = "MaxRetryCount" +sig = "int MaxRetryCount { get; init; }" +returns = "int" +file = "Configuration\\FExDbConfig.cs" + +[[properties]] +parent = "FExDbConfig" +name = "MaxRetryDelay" +sig = "TimeSpan MaxRetryDelay { get; init; }" +returns = "TimeSpan" +file = "Configuration\\FExDbConfig.cs" + +[[properties]] +parent = "FExDbConfig" +name = "TrustCertificate" +sig = "bool TrustCertificate { get; init; }" +returns = "bool" +file = "Configuration\\FExDbConfig.cs" + +[[properties]] +parent = "FExDbConfig" +name = "EnableSensitiveDataLogging" +sig = "bool EnableSensitiveDataLogging { get; init; }" +returns = "bool" +file = "Configuration\\FExDbConfig.cs" + +[[properties]] +parent = "FExDbConfig" +name = "CommandTimeout" +sig = "int? CommandTimeout { get; init; }" +returns = "int?" +file = "Configuration\\FExDbConfig.cs" + +[[methods]] +parent = "FExDbConfig" +name = "ParseSqlConnectionString" +sig = "static FExDbConfig ParseSqlConnectionString(string originalConnectionString)" +returns = "FExDbConfig" +file = "Configuration\\FExDbConfig.cs" +static = true + [[interfaces]] name = "IBulkDbConfig" ns = "FEx.EFCore.Configuration" file = "Configuration\\IBulkDbConfig.cs" +[[properties]] +parent = "IBulkDbConfig" +name = "Config" +sig = "Func Config { get; }" +returns = "Func" +file = "Configuration\\IBulkDbConfig.cs" + +[[properties]] +parent = "IBulkDbConfig" +name = "ParallelBulkOperations" +sig = "int ParallelBulkOperations { get; }" +returns = "int" +file = "Configuration\\IBulkDbConfig.cs" + [[interfaces]] name = "IDbServiceConfig" ns = "FEx.EFCore.Configuration" file = "Configuration\\IDbServiceConfig.cs" +[[properties]] +parent = "IDbServiceConfig" +name = "BulkDbConfig" +sig = "IBulkDbConfig BulkDbConfig { get; }" +returns = "IBulkDbConfig" +file = "Configuration\\IDbServiceConfig.cs" + +[[properties]] +parent = "IDbServiceConfig" +name = "DbConfig" +sig = "IFExDbConfig DbConfig { get; }" +returns = "IFExDbConfig" +file = "Configuration\\IDbServiceConfig.cs" + [[enums]] name = "SqlDialect" ns = "FEx.EFCore.Enums" @@ -65,12 +625,140 @@ ns = "FEx.EFCore.Extensions" file = "Extensions\\BulkOperationsExtensions.cs" static = true +[[properties]] +parent = "BulkOperationsExtensions" +name = "DefaultBulkConfig" +sig = "static Func DefaultBulkConfig { get; }" +returns = "Func" +file = "Extensions\\BulkOperationsExtensions.cs" +static = true + +[[extensions]] +name = "BulkInsertAsync" +returns = "Task" +sig = "Task BulkInsertAsync(this IBulkDbServiceBase service, IList entities, string errorMessage = null, CancellationToken cancellationToken = default)" +file = "Extensions\\BulkOperationsExtensions.cs" + +[[extensions]] +name = "BulkDeleteAsync" +returns = "Task" +sig = "Task BulkDeleteAsync(this IBulkDbServiceBase service, IList entities, string errorMessage = null, CancellationToken cancellationToken = default)" +file = "Extensions\\BulkOperationsExtensions.cs" + +[[extensions]] +name = "BulkInsertOrUpdateAsync" +returns = "Task" +sig = "Task BulkInsertOrUpdateAsync(this IBulkDbServiceBase service, IList entities, string errorMessage = null, CancellationToken cancellationToken = default)" +file = "Extensions\\BulkOperationsExtensions.cs" + +[[extensions]] +name = "BulkInsertOrUpdateOrDeleteAsync" +returns = "Task" +sig = "Task BulkInsertOrUpdateOrDeleteAsync( this IBulkDbServiceBase service, IList entities, string errorMessage = null, CancellationToken cancellationToken = default)" +file = "Extensions\\BulkOperationsExtensions.cs" + +[[extensions]] +name = "BulkReadAsync" +returns = "Task" +sig = "Task BulkReadAsync(this IBulkDbServiceBase service, IList entities, string errorMessage = null, CancellationToken cancellationToken = default)" +file = "Extensions\\BulkOperationsExtensions.cs" + +[[extensions]] +name = "BulkUpdateAsync" +returns = "Task" +sig = "Task BulkUpdateAsync(this IBulkDbServiceBase service, IList entities, string errorMessage = null, CancellationToken cancellationToken = default)" +file = "Extensions\\BulkOperationsExtensions.cs" + [[classes]] name = "DbContextExtensions" ns = "FEx.EFCore.Extensions" file = "Extensions\\DbContextExtensions.cs" static = true +[[extensions]] +name = "ValidateAndSaveChangesAsync" +returns = "Task" +sig = "Task ValidateAndSaveChangesAsync(this TDbContext dbContext)" +file = "Extensions\\DbContextExtensions.cs" + +[[extensions]] +name = "ValidateAndSaveChangesAsync" +returns = "Task" +sig = "Task ValidateAndSaveChangesAsync(this TDbContext dbContext, string id, bool validateAllProperties, bool acceptAllChangesOnSuccess, Action> onValidationStart, Action onFaultyEntity, Action> onValidationFail, Action> onValidationSuccess)" +file = "Extensions\\DbContextExtensions.cs" + +[[extensions]] +name = "ValidateChangedEntities" +returns = "Result" +sig = "Result ValidateChangedEntities(this TDbContext dbContext)" +file = "Extensions\\DbContextExtensions.cs" + +[[extensions]] +name = "ValidateChangedEntities" +returns = "Result" +sig = "Result ValidateChangedEntities(this TDbContext dbContext, string id, bool validateAllProperties, Action> onValidationStart, Action onFaultyEntity, Action> onValidationFail, Action> onValidationSuccess)" +file = "Extensions\\DbContextExtensions.cs" + +[[extensions]] +name = "AddOrUpdateAsync" +returns = "Task" +sig = "Task AddOrUpdateAsync(this DbSet dbSet, T data, Expression> existenceFunc)" +file = "Extensions\\DbContextExtensions.cs" + +[[extensions]] +name = "GetChangedEntities" +returns = "IList" +sig = "IList GetChangedEntities(this TDbContext dbContext)" +file = "Extensions\\DbContextExtensions.cs" + +[[extensions]] +name = "IsSqlite" +returns = "bool" +sig = "bool IsSqlite(this TDbContext context)" +file = "Extensions\\DbContextExtensions.cs" + +[[extensions]] +name = "IsMySql" +returns = "bool" +sig = "bool IsMySql(this TDbContext context)" +file = "Extensions\\DbContextExtensions.cs" + +[[extensions]] +name = "IsPostrgeSql" +returns = "bool" +sig = "bool IsPostrgeSql(this TDbContext context)" +file = "Extensions\\DbContextExtensions.cs" + +[[extensions]] +name = "IsSqlServer" +returns = "bool" +sig = "bool IsSqlServer(this TDbContext context)" +file = "Extensions\\DbContextExtensions.cs" + +[[extensions]] +name = "GetProvider" +returns = "SqlDialect?" +sig = "SqlDialect? GetProvider(this TDbContext context)" +file = "Extensions\\DbContextExtensions.cs" + +[[extensions]] +name = "ExecuteReader" +returns = "string" +sig = "string ExecuteReader(this TDbContext db, string commandText, params DbParameter[] parameters)" +file = "Extensions\\DbContextExtensions.cs" + +[[extensions]] +name = "GetJsonCommand" +returns = "string" +sig = "string GetJsonCommand(this TDbContext context)" +file = "Extensions\\DbContextExtensions.cs" + +[[extensions]] +name = "EnsureCreatingMissingTables" +returns = "void" +sig = "void EnsureCreatingMissingTables(this TDbContext dbContext)" +file = "Extensions\\DbContextExtensions.cs" + [[classes]] name = "DbContextOptionsBuilderExtensions" ns = "FEx.EFCore.Extensions" @@ -79,30 +767,26 @@ static = true [[extensions]] name = "ConfigureDbContext" -sig = "bool ConfigureDbContext(this DbContextOptionsBuilder options, - IFExDbConfig config, - ISqlDbHelper sqlDbHelper)" returns = "bool" +sig = "bool ConfigureDbContext(this DbContextOptionsBuilder options, IFExDbConfig config, ISqlDbHelper sqlDbHelper)" file = "Extensions\\DbContextOptionsBuilderExtensions.cs" [[extensions]] name = "UseSqlite" -sig = "void UseSqlite(this DbContextOptionsBuilder options, IFExDbConfig config)" returns = "void" +sig = "void UseSqlite(this DbContextOptionsBuilder options, IFExDbConfig config)" file = "Extensions\\DbContextOptionsBuilderExtensions.cs" [[extensions]] name = "UseSqlServer" -sig = "bool UseSqlServer(this DbContextOptionsBuilder options, IFExDbConfig config)" returns = "bool" +sig = "bool UseSqlServer(this DbContextOptionsBuilder options, IFExDbConfig config)" file = "Extensions\\DbContextOptionsBuilderExtensions.cs" [[extensions]] name = "UseSqlServer" -sig = "bool UseSqlServer(this DbContextOptionsBuilder options, - IFExDbConfig config, - Action configure)" returns = "bool" +sig = "bool UseSqlServer(this DbContextOptionsBuilder options, IFExDbConfig config, Action configure)" file = "Extensions\\DbContextOptionsBuilderExtensions.cs" [[classes]] @@ -113,8 +797,8 @@ static = true [[extensions]] name = "GetMappedProperties" -sig = "IReadOnlyCollection GetMappedProperties(this IEntityType entityType)" returns = "IReadOnlyCollection" +sig = "IReadOnlyCollection GetMappedProperties(this IEntityType entityType)" file = "Extensions\\EntityTypeExtensions.cs" [[classes]] @@ -123,37 +807,229 @@ ns = "FEx.EFCore.Extensions" file = "Extensions\\PooledDbServiceExtensions.cs" static = true +[[extensions]] +name = "RunActionInDbContextAsync" +returns = "Task" +sig = "Task RunActionInDbContextAsync(this IPooledDbService service, Action func)" +file = "Extensions\\PooledDbServiceExtensions.cs" + +[[extensions]] +name = "RunFuncInDbContextAsync" +returns = "Task" +sig = "Task RunFuncInDbContextAsync(this IPooledDbService service, Func func)" +file = "Extensions\\PooledDbServiceExtensions.cs" + +[[extensions]] +name = "RunTaskInDbContextAsync" +returns = "Task" +sig = "Task RunTaskInDbContextAsync(this IPooledDbService service, Func func)" +file = "Extensions\\PooledDbServiceExtensions.cs" + +[[extensions]] +name = "RunTaskInDbContextAsync" +returns = "Task" +sig = "Task RunTaskInDbContextAsync(this IPooledDbService service, Func> func)" +file = "Extensions\\PooledDbServiceExtensions.cs" + +[[extensions]] +name = "RunTaskInDbContextAsync" +returns = "Task" +sig = "Task RunTaskInDbContextAsync(this IPooledDbService service, Func>> func)" +file = "Extensions\\PooledDbServiceExtensions.cs" + [[classes]] name = "EFCoreHelper" ns = "FEx.EFCore.Helpers" file = "Helpers\\EFCoreHelper.cs" static = true +[[methods]] +parent = "EFCoreHelper" +name = "HasKey" +sig = "static Expression> HasKey(TKey key, string keyPropertyName)" +returns = "Expression>" +file = "Helpers\\EFCoreHelper.cs" +static = true + [[classes]] name = "ResilientTransaction" ns = "FEx.EFCore.Helpers" summary = "Use of an EF Core resiliency strategy when using multiple DbContexts within an explicit BeginTransaction(): See: https://docs.microsoft.com/en-us/ef/core/miscellaneous/connection-resiliency" file = "Helpers\\ResilientTransaction.cs" +[[ctors]] +parent = "ResilientTransaction" +sig = "ResilientTransaction(IFExLogger logger)" +file = "Helpers\\ResilientTransaction.cs" + +[[methods]] +parent = "ResilientTransaction" +name = "ExecuteAsync" +sig = "Task ExecuteAsync(DbContext context, Func> action, string id)" +returns = "Task" +file = "Helpers\\ResilientTransaction.cs" + +[[methods]] +parent = "ResilientTransaction" +name = "ExecuteAsync" +sig = "Task ExecuteAsync(DbContext context, Func> action, string id, IsolationLevel isolationLevel, int? delayOnTimeout)" +returns = "Task" +file = "Helpers\\ResilientTransaction.cs" + +[[methods]] +parent = "ResilientTransaction" +name = "ExecuteAsync" +sig = "Task ExecuteAsync(DbContext context, Func action, string id)" +returns = "Task" +file = "Helpers\\ResilientTransaction.cs" + +[[methods]] +parent = "ResilientTransaction" +name = "ExecuteAsync" +sig = "Task ExecuteAsync(DbContext context, Func action, string id, IsolationLevel isolationLevel, int? delayOnTimeout)" +returns = "Task" +file = "Helpers\\ResilientTransaction.cs" + +[[methods]] +parent = "ResilientTransaction" +name = "Execute" +sig = "T Execute(DbContext context, Func action, string id, IsolationLevel isolationLevel = IsolationLevel.Unspecified, int? delayOnTimeout = null)" +returns = "T" +file = "Helpers\\ResilientTransaction.cs" + [[classes]] name = "SQLConnectionHelper" ns = "FEx.EFCore.Helpers" file = "Helpers\\SQLConnectionHelper.cs" static = true +[[methods]] +parent = "SQLConnectionHelper" +name = "CheckDbConnectionAsync" +sig = "static Task CheckDbConnectionAsync(string connectionString)" +returns = "Task" +file = "Helpers\\SQLConnectionHelper.cs" +static = true + +[[methods]] +parent = "SQLConnectionHelper" +name = "CheckDbConnectionAsync" +sig = "static Task CheckDbConnectionAsync(string connectionString, CancellationToken cancellationToken)" +returns = "Task" +file = "Helpers\\SQLConnectionHelper.cs" +static = true + +[[methods]] +parent = "SQLConnectionHelper" +name = "CheckDbConnection" +sig = "static bool CheckDbConnection(string connectionString)" +returns = "bool" +file = "Helpers\\SQLConnectionHelper.cs" +static = true + +[[methods]] +parent = "SQLConnectionHelper" +name = "CheckMasterDbConnectionAsync" +sig = "static Task CheckMasterDbConnectionAsync(IFExDbConfig config, CancellationToken cancellationToken = default)" +returns = "Task" +file = "Helpers\\SQLConnectionHelper.cs" +static = true + +[[methods]] +parent = "SQLConnectionHelper" +name = "CheckMasterDbConnection" +sig = "static bool CheckMasterDbConnection(IFExDbConfig config)" +returns = "bool" +file = "Helpers\\SQLConnectionHelper.cs" +static = true + +[[methods]] +parent = "SQLConnectionHelper" +name = "GetConnectionString" +sig = "static string GetConnectionString(IFExDbConfig config)" +returns = "string" +file = "Helpers\\SQLConnectionHelper.cs" +static = true + [[interfaces]] name = "IBulkDbServiceBase" ns = "FEx.EFCore.Interfaces" +base = "IDbServiceBase" +file = "Interfaces\\IBulkDbServiceBase.cs" + +[[properties]] +parent = "IBulkDbServiceBase" +name = "BulkConfig" +sig = "Func BulkConfig { get; }" +returns = "Func" +file = "Interfaces\\IBulkDbServiceBase.cs" + +[[properties]] +parent = "IBulkDbServiceBase" +name = "BulkOperationsSemaphore" +sig = "SemaphoreSlim BulkOperationsSemaphore { get; }" +returns = "SemaphoreSlim" +file = "Interfaces\\IBulkDbServiceBase.cs" + +[[methods]] +parent = "IBulkDbServiceBase" +name = "ProgressAction" +sig = "void ProgressAction(decimal progress, string operationId, OperationType type, string tableName)" +returns = "void" file = "Interfaces\\IBulkDbServiceBase.cs" [[interfaces]] name = "IDbServiceBase" ns = "FEx.EFCore.Interfaces" +base = "IPooledDbService" +file = "Interfaces\\IDbServiceBase.cs" + +[[methods]] +parent = "IDbServiceBase" +name = "AddAsync" +sig = "Task> AddAsync(T entity, string errorMessage = null, bool saveChanges = true, bool useTransaction = true) where T : class" +returns = "Task>" +file = "Interfaces\\IDbServiceBase.cs" + +[[methods]] +parent = "IDbServiceBase" +name = "AddRangeAsync" +sig = "Task AddRangeAsync(IEnumerable entities, string errorMessage = null, bool saveChanges = true, bool useTransaction = true) where T : class" +returns = "Task" +file = "Interfaces\\IDbServiceBase.cs" + +[[methods]] +parent = "IDbServiceBase" +name = "GetEntitiesAsync" +sig = "Task> GetEntitiesAsync(Expression>> query) where T : class" +returns = "Task>" +file = "Interfaces\\IDbServiceBase.cs" + +[[methods]] +parent = "IDbServiceBase" +name = "RemoveAsync" +sig = "Task> RemoveAsync(T entity, string errorMessage = null, bool saveChanges = true, bool useTransaction = true) where T : class" +returns = "Task>" +file = "Interfaces\\IDbServiceBase.cs" + +[[methods]] +parent = "IDbServiceBase" +name = "UpdateAsync" +sig = "Task> UpdateAsync(T entity, string errorMessage = null, bool saveChanges = true, bool useTransaction = true) where T : class" +returns = "Task>" file = "Interfaces\\IDbServiceBase.cs" [[interfaces]] name = "IEFCoreDatabaseBackedService" ns = "FEx.EFCore.Interfaces" +base = "IDbServiceBase" +file = "Interfaces\\IEFCoreDatabaseBackedService.cs" + +[[properties]] +parent = "IEFCoreDatabaseBackedService" +name = "DbKey" +sig = "string DbKey { get; }" +returns = "string" file = "Interfaces\\IEFCoreDatabaseBackedService.cs" [[interfaces]] @@ -161,9 +1037,186 @@ name = "IFExDbConfig" ns = "FEx.EFCore.Interfaces" file = "Interfaces\\IFExDbConfig.cs" +[[properties]] +parent = "IFExDbConfig" +name = "SqlInstance" +sig = "string SqlInstance { get; set; }" +returns = "string" +file = "Interfaces\\IFExDbConfig.cs" + +[[properties]] +parent = "IFExDbConfig" +name = "SqlDbName" +sig = "string SqlDbName { get; }" +returns = "string" +file = "Interfaces\\IFExDbConfig.cs" + +[[properties]] +parent = "IFExDbConfig" +name = "Username" +sig = "string Username { get; }" +returns = "string" +file = "Interfaces\\IFExDbConfig.cs" + +[[properties]] +parent = "IFExDbConfig" +name = "Password" +sig = "string Password { get; }" +returns = "string" +file = "Interfaces\\IFExDbConfig.cs" + +[[properties]] +parent = "IFExDbConfig" +name = "SqliteDbFile" +sig = "FileInfo SqliteDbFile { get; }" +returns = "FileInfo" +file = "Interfaces\\IFExDbConfig.cs" + +[[properties]] +parent = "IFExDbConfig" +name = "CommandTimeout" +sig = "int? CommandTimeout { get; }" +returns = "int?" +file = "Interfaces\\IFExDbConfig.cs" + +[[properties]] +parent = "IFExDbConfig" +name = "MaxRetryCount" +sig = "int MaxRetryCount { get; }" +returns = "int" +file = "Interfaces\\IFExDbConfig.cs" + +[[properties]] +parent = "IFExDbConfig" +name = "MaxRetryDelay" +sig = "TimeSpan MaxRetryDelay { get; }" +returns = "TimeSpan" +file = "Interfaces\\IFExDbConfig.cs" + +[[properties]] +parent = "IFExDbConfig" +name = "PoolSize" +sig = "int PoolSize { get; }" +returns = "int" +file = "Interfaces\\IFExDbConfig.cs" + +[[properties]] +parent = "IFExDbConfig" +name = "DelayOnTimeout" +sig = "int DelayOnTimeout { get; }" +returns = "int" +file = "Interfaces\\IFExDbConfig.cs" + +[[properties]] +parent = "IFExDbConfig" +name = "RunMigrations" +sig = "bool RunMigrations { get; set; }" +returns = "bool" +file = "Interfaces\\IFExDbConfig.cs" + +[[properties]] +parent = "IFExDbConfig" +name = "GetMappings" +sig = "bool GetMappings { get; set; }" +returns = "bool" +file = "Interfaces\\IFExDbConfig.cs" + +[[properties]] +parent = "IFExDbConfig" +name = "DropIfMigrationFailed" +sig = "bool DropIfMigrationFailed { get; }" +returns = "bool" +file = "Interfaces\\IFExDbConfig.cs" + +[[properties]] +parent = "IFExDbConfig" +name = "UseSqlite" +sig = "bool UseSqlite { get; }" +returns = "bool" +file = "Interfaces\\IFExDbConfig.cs" + +[[properties]] +parent = "IFExDbConfig" +name = "TrustCertificate" +sig = "bool TrustCertificate { get; }" +returns = "bool" +file = "Interfaces\\IFExDbConfig.cs" + +[[properties]] +parent = "IFExDbConfig" +name = "EnableSensitiveDataLogging" +sig = "bool EnableSensitiveDataLogging { get; }" +returns = "bool" +file = "Interfaces\\IFExDbConfig.cs" + [[interfaces]] name = "IPooledDbService" ns = "FEx.EFCore.Interfaces" +base = "IAsyncInitializable" +file = "Interfaces\\IPooledDbService.cs" + +[[properties]] +parent = "IPooledDbService" +name = "TableMappings" +sig = "Map TableMappings { get; }" +returns = "Map" +summary = "Map of model to DB mappings. ForwardIndex contains model entities names to table names in DB mapping. ReverseIndex contains table names in DB to model entities names mapping." +file = "Interfaces\\IPooledDbService.cs" + +[[properties]] +parent = "IPooledDbService" +name = "Mappings" +sig = "IReadOnlyDictionary Mappings { get; }" +returns = "IReadOnlyDictionary" +file = "Interfaces\\IPooledDbService.cs" + +[[methods]] +parent = "IPooledDbService" +name = "RunMigrationsAsync" +sig = "Task RunMigrationsAsync()" +returns = "Task" +file = "Interfaces\\IPooledDbService.cs" + +[[methods]] +parent = "IPooledDbService" +name = "MigrateAsync" +sig = "Task MigrateAsync()" +returns = "Task" +file = "Interfaces\\IPooledDbService.cs" + +[[methods]] +parent = "IPooledDbService" +name = "RunActionInDbContextAsync" +sig = "Task RunActionInDbContextAsync(Action func, string errorMessage, bool saveChanges, bool useTransaction)" +returns = "Task" +file = "Interfaces\\IPooledDbService.cs" + +[[methods]] +parent = "IPooledDbService" +name = "RunFuncInDbContextAsync" +sig = "Task RunFuncInDbContextAsync(Func func, string errorMessage = null, bool saveChanges = true, bool useTransaction = true)" +returns = "Task" +file = "Interfaces\\IPooledDbService.cs" + +[[methods]] +parent = "IPooledDbService" +name = "RunTaskInDbContextAsync" +sig = "Task RunTaskInDbContextAsync(Func func, string errorMessage = null, bool saveChanges = true, bool useTransaction = true)" +returns = "Task" +file = "Interfaces\\IPooledDbService.cs" + +[[methods]] +parent = "IPooledDbService" +name = "RunTaskInDbContextAsync" +sig = "Task RunTaskInDbContextAsync(Func> func, string errorMessage = null, bool saveChanges = true, bool useTransaction = true)" +returns = "Task" +file = "Interfaces\\IPooledDbService.cs" + +[[methods]] +parent = "IPooledDbService" +name = "RunTaskInDbContextAsync" +sig = "Task RunTaskInDbContextAsync(Func>> func, string errorMessage = null, bool saveChanges = true, bool useTransaction = true)" +returns = "Task" file = "Interfaces\\IPooledDbService.cs" [[classes]] @@ -171,36 +1224,418 @@ name = "ChangeInfo" ns = "FEx.EFCore.Models" file = "Models\\ChangeInfo.cs" +[[properties]] +parent = "ChangeInfo" +name = "Change" +sig = "Change Change { get; }" +returns = "Change" +file = "Models\\ChangeInfo.cs" + +[[properties]] +parent = "ChangeInfo" +name = "Key" +sig = "TKey Key { get; }" +returns = "TKey" +file = "Models\\ChangeInfo.cs" + +[[properties]] +parent = "ChangeInfo" +name = "Value" +sig = "TValue Value { get; }" +returns = "TValue" +file = "Models\\ChangeInfo.cs" + +[[properties]] +parent = "ChangeInfo" +name = "Reason" +sig = "ChangeReason Reason { get; }" +returns = "ChangeReason" +file = "Models\\ChangeInfo.cs" + +[[properties]] +parent = "ChangeInfo" +name = "ToDelete" +sig = "bool ToDelete { get; }" +returns = "bool" +file = "Models\\ChangeInfo.cs" + +[[properties]] +parent = "ChangeInfo" +name = "ExistsInDb" +sig = "bool ExistsInDb { get; set; }" +returns = "bool" +file = "Models\\ChangeInfo.cs" + +[[ctors]] +parent = "ChangeInfo" +sig = "ChangeInfo(Change change)" +file = "Models\\ChangeInfo.cs" + [[classes]] name = "EntityValidationFail" ns = "FEx.EFCore.Models" file = "Models\\EntityValidationFail.cs" +[[properties]] +parent = "EntityValidationFail" +name = "Entry" +sig = "EntityEntry Entry { get; }" +returns = "EntityEntry" +file = "Models\\EntityValidationFail.cs" + +[[properties]] +parent = "EntityValidationFail" +name = "FailedValidations" +sig = "IReadOnlyCollection FailedValidations { get; }" +returns = "IReadOnlyCollection" +file = "Models\\EntityValidationFail.cs" + +[[properties]] +parent = "EntityValidationFail" +name = "Index" +sig = "int Index { get; }" +returns = "int" +file = "Models\\EntityValidationFail.cs" + +[[ctors]] +parent = "EntityValidationFail" +sig = "EntityValidationFail(EntityEntry entry, IReadOnlyCollection failedValidations, int index)" +file = "Models\\EntityValidationFail.cs" + +[[classes]] +name = "Mapping" +ns = "FEx.EFCore.Models" +file = "Models\\Mapping.cs" + +[[properties]] +parent = "Mapping" +name = "ClrTypeName" +sig = "string ClrTypeName { get; init; }" +returns = "string" +file = "Models\\Mapping.cs" + +[[properties]] +parent = "Mapping" +name = "TableName" +sig = "string TableName { get; init; }" +returns = "string" +file = "Models\\Mapping.cs" + +[[properties]] +parent = "Mapping" +name = "Properties" +sig = "IReadOnlyCollection Properties { get; init; }" +returns = "IReadOnlyCollection" +file = "Models\\Mapping.cs" + +[[methods]] +parent = "Mapping" +name = "ToString" +sig = "string ToString()" +returns = "string" +file = "Models\\Mapping.cs" + [[classes]] name = "BulkDbServiceBase" ns = "FEx.EFCore.Services" -base = "DbServiceBase, IBulkDbServiceBase - where TDbContext : DbContext" +base = "DbServiceBase, IBulkDbServiceBase" +file = "Services\\BulkDbServiceBase.cs" + +[[properties]] +parent = "BulkDbServiceBase" +name = "BulkConfig" +sig = "Func BulkConfig { get; }" +returns = "Func" +file = "Services\\BulkDbServiceBase.cs" + +[[properties]] +parent = "BulkDbServiceBase" +name = "BulkOperationsSemaphore" +sig = "SemaphoreSlim BulkOperationsSemaphore { get; }" +returns = "SemaphoreSlim" +file = "Services\\BulkDbServiceBase.cs" + +[[ctors]] +parent = "BulkDbServiceBase" +sig = "BulkDbServiceBase(IScopeProvider scopeProvider, IBulkDbConfig bulkDbConfig, ResilientTransaction resilientTransaction, IFExDbConfig dbConfig, IAsyncInitializable[] dependencies)" +file = "Services\\BulkDbServiceBase.cs" + +[[methods]] +parent = "BulkDbServiceBase" +name = "ProgressAction" +sig = "void ProgressAction(decimal progress, string operationId, OperationType type, string tableName)" +returns = "void" +file = "Services\\BulkDbServiceBase.cs" + +[[methods]] +parent = "BulkDbServiceBase" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" file = "Services\\BulkDbServiceBase.cs" [[classes]] name = "DbServiceBase" ns = "FEx.EFCore.Services" -base = "PooledDbService, IDbServiceBase - where TDbContext : DbContext" +base = "PooledDbService, IDbServiceBase" +file = "Services\\DbServiceBase.cs" + +[[ctors]] +parent = "DbServiceBase" +sig = "DbServiceBase(IScopeProvider scopeProvider, ResilientTransaction resilientTransaction, IFExDbConfig dbConfig, IAsyncInitializable[] dependencies)" +file = "Services\\DbServiceBase.cs" + +[[methods]] +parent = "DbServiceBase" +name = "GetEntitiesAsync" +sig = "Task> GetEntitiesAsync(Expression>> query) where T : class" +returns = "Task>" +file = "Services\\DbServiceBase.cs" + +[[methods]] +parent = "DbServiceBase" +name = "AddAsync" +sig = "Task> AddAsync(T entity, string errorMessage = null, bool saveChanges = true, bool useTransaction = true) where T : class" +returns = "Task>" +file = "Services\\DbServiceBase.cs" + +[[methods]] +parent = "DbServiceBase" +name = "UpdateAsync" +sig = "Task> UpdateAsync(T entity, string errorMessage = null, bool saveChanges = true, bool useTransaction = true) where T : class" +returns = "Task>" +file = "Services\\DbServiceBase.cs" + +[[methods]] +parent = "DbServiceBase" +name = "RemoveAsync" +sig = "Task> RemoveAsync(T entity, string errorMessage = null, bool saveChanges = true, bool useTransaction = true) where T : class" +returns = "Task>" +file = "Services\\DbServiceBase.cs" + +[[methods]] +parent = "DbServiceBase" +name = "AddRangeAsync" +sig = "Task AddRangeAsync(IEnumerable entities, string errorMessage = null, bool saveChanges = true, bool useTransaction = true) where T : class" +returns = "Task" +file = "Services\\DbServiceBase.cs" + +[[methods]] +parent = "DbServiceBase" +name = "InternalGetEntities" +sig = "IQueryable InternalGetEntities(TDbContext dbContext, Expression>> query) where T : class" +returns = "IQueryable" file = "Services\\DbServiceBase.cs" [[classes]] name = "EFCoreDatabaseBackedService" ns = "FEx.EFCore.Services" -base = "BulkDbServiceBase, - IEFCoreDatabaseBackedService where TDbContext : DbContext" +base = "BulkDbServiceBase, IEFCoreDatabaseBackedService" +file = "Services\\EFCoreDatabaseBackedService.cs" + +[[properties]] +parent = "EFCoreDatabaseBackedService" +name = "DbKey" +sig = "string DbKey { get; set; }" +returns = "string" +file = "Services\\EFCoreDatabaseBackedService.cs" + +[[ctors]] +parent = "EFCoreDatabaseBackedService" +sig = "EFCoreDatabaseBackedService(IScopeProvider scopeProvider, IDbServiceConfig config, ResilientTransaction resilientTransaction, ISqlDbHelper dbHelper, IAsyncInitializable[] dependencies)" +file = "Services\\EFCoreDatabaseBackedService.cs" + +[[methods]] +parent = "EFCoreDatabaseBackedService" +name = "EnsureIsInitializedAsync" +sig = "Task EnsureIsInitializedAsync()" +returns = "Task" +file = "Services\\EFCoreDatabaseBackedService.cs" + +[[methods]] +parent = "EFCoreDatabaseBackedService" +name = "OnInitializeAsync" +sig = "Task OnInitializeAsync()" +returns = "Task" file = "Services\\EFCoreDatabaseBackedService.cs" [[classes]] name = "PooledDbService" ns = "FEx.EFCore.Services" -base = "AsyncInitializable, IPooledDbService - where TDbContext : DbContext" +base = "AsyncInitializable, IPooledDbService" +file = "Services\\PooledDbService.cs" + +[[properties]] +parent = "PooledDbService" +name = "DelayOnTimeout" +sig = "int? DelayOnTimeout { get; }" +returns = "int?" +file = "Services\\PooledDbService.cs" + +[[properties]] +parent = "PooledDbService" +name = "Mappings" +sig = "IReadOnlyDictionary Mappings { get; }" +returns = "IReadOnlyDictionary" +file = "Services\\PooledDbService.cs" + +[[properties]] +parent = "PooledDbService" +name = "TableMappings" +sig = "Map TableMappings { get; }" +returns = "Map" +file = "Services\\PooledDbService.cs" + +[[ctors]] +parent = "PooledDbService" +sig = "PooledDbService(IScopeProvider scopeProvider, ResilientTransaction transaction, IFExDbConfig dbConfig, params IAsyncInitializable[] dependencies)" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "RunTaskInDbContextAsync" +sig = "Task RunTaskInDbContextAsync(Func func, string errorMessage = null, bool saveChanges = true, bool useTransaction = true)" +returns = "Task" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "RunTaskInDbContextAsync" +sig = "Task RunTaskInDbContextAsync(Func> func, string errorMessage = null, bool saveChanges = true, bool useTransaction = true)" +returns = "Task" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "RunTaskInDbContextAsync" +sig = "Task RunTaskInDbContextAsync(Func>> func, string errorMessage = null, bool saveChanges = true, bool useTransaction = true)" +returns = "Task" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "RunMigrationsAsync" +sig = "Task RunMigrationsAsync()" +returns = "Task" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "MigrateAsync" +sig = "Task MigrateAsync()" +returns = "Task" +summary = "Migrate does the same job that EnsureCreated, but also adds table with migrations history" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "RunActionInDbContextAsync" +sig = "Task RunActionInDbContextAsync(Action func, string errorMessage, bool saveChanges, bool useTransaction)" +returns = "Task" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "RunFuncInDbContextAsync" +sig = "Task RunFuncInDbContextAsync(Func func, string errorMessage = null, bool saveChanges = true, bool useTransaction = true)" +returns = "Task" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "RunWithinTransaction" +sig = "T RunWithinTransaction(Func func, string errorMessage, bool saveChanges, bool useTransaction, IsolationLevel isolationLevel)" +returns = "T" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "RunWithinTransactionAsync" +sig = "Task RunWithinTransactionAsync(Func func, string errorMessage = null, bool saveChanges = true, bool useTransaction = true, IsolationLevel isolationLevel = IsolationLevel.Unspecified)" +returns = "Task" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "RunWithinTransactionAsync" +sig = "Task RunWithinTransactionAsync(Func> func, string errorMessage = null, bool saveChanges = true, bool useTransaction = true, IsolationLevel isolationLevel = IsolationLevel.Unspecified)" +returns = "Task" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "AfterAppliedMigrationAsync" +sig = "Task AfterAppliedMigrationAsync()" +returns = "Task" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "OnValidationSuccess" +sig = "void OnValidationSuccess(string id, IReadOnlyCollection entities)" +returns = "void" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "OnValidationFail" +sig = "void OnValidationFail(string id, IReadOnlyCollection failedValidations)" +returns = "void" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "OnFaultyEntity" +sig = "void OnFaultyEntity(string id, EntityValidationFail failedValidation)" +returns = "void" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "OnValidationStart" +sig = "void OnValidationStart(string id, IReadOnlyCollection entities)" +returns = "void" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "OnInitializeAsync" +sig = "Task OnInitializeAsync()" +returns = "Task" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "EnsureMappingSnapshotAsync" +sig = "Task EnsureMappingSnapshotAsync()" +returns = "Task" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "ValidateAndSaveChanges" +sig = "Result ValidateAndSaveChanges(TDbContext dbContext, string id)" +returns = "Result" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "ValidateAndSaveChanges" +sig = "Result ValidateAndSaveChanges(TDbContext dbContext, string id, bool validateAllProperties, bool acceptAllChangesOnSuccess)" +returns = "Result" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "ValidateAndSaveChangesAsync" +sig = "Task> ValidateAndSaveChangesAsync(TDbContext dbContext, string id, bool validateAllProperties = true, bool acceptAllChangesOnSuccess = true)" +returns = "Task>" +file = "Services\\PooledDbService.cs" + +[[methods]] +parent = "PooledDbService" +name = "ShrinkDbAsync" +sig = "Task ShrinkDbAsync()" +returns = "Task" file = "Services\\PooledDbService.cs" diff --git a/.api-surface/FEx/Encryption.toml b/.api-surface/FEx/Encryption.toml index 9c24e43f..31f1cc8e 100644 --- a/.api-surface/FEx/Encryption.toml +++ b/.api-surface/FEx/Encryption.toml @@ -8,10 +8,18 @@ ns = "FEx.Encryption" file = "EncryptionHelper.cs" static = true +[[methods]] +parent = "EncryptionHelper" +name = "Decode" +sig = "static string Decode(string encryptedInput)" +returns = "string" +file = "EncryptionHelper.cs" +static = true + [[extensions]] name = "Encode" -sig = "string Encode(this string valueToEncrypt)" returns = "string" +sig = "string Encode(this string valueToEncrypt)" file = "EncryptionHelper.cs" [[classes]] @@ -20,6 +28,26 @@ ns = "FEx.Encryption" base = "InitializeOnlyModule" file = "FExEncryption.cs" +[[properties]] +parent = "FExEncryption" +name = "PassPhrase" +sig = "static string PassPhrase { get; }" +returns = "string" +file = "FExEncryption.cs" +static = true + +[[ctors]] +parent = "FExEncryption" +sig = "FExEncryption(IFExEncryptionSettings settings)" +file = "FExEncryption.cs" + +[[methods]] +parent = "FExEncryption" +name = "OnInitialize" +sig = "void OnInitialize()" +returns = "void" +file = "FExEncryption.cs" + [[classes]] name = "FExEncryptionModule" ns = "FEx.Encryption" @@ -31,14 +59,72 @@ ns = "FEx.Encryption" base = "NotifyPropertyChanged" file = "SecureNotifyPropertyChanged.cs" +[[methods]] +parent = "SecureNotifyPropertyChanged" +name = "IsValid" +sig = "bool IsValid(string propertyName, string decryptedValue)" +returns = "bool" +file = "SecureNotifyPropertyChanged.cs" + +[[methods]] +parent = "SecureNotifyPropertyChanged" +name = "DecryptFromSource" +sig = "string DecryptFromSource(ref string source, [CallerMemberName] string propertyName = null)" +returns = "string" +file = "SecureNotifyPropertyChanged.cs" + +[[methods]] +parent = "SecureNotifyPropertyChanged" +name = "DecryptFromJsonSource" +sig = "T DecryptFromJsonSource(ref string source, [CallerMemberName] string propertyName = null)" +returns = "T" +file = "SecureNotifyPropertyChanged.cs" + +[[methods]] +parent = "SecureNotifyPropertyChanged" +name = "EncryptJsonSource" +sig = "bool EncryptJsonSource(ref string backingField, T newValue, Action onPropertyChanged = null, [CallerMemberName] string propertyName = null)" +returns = "bool" +file = "SecureNotifyPropertyChanged.cs" + +[[methods]] +parent = "SecureNotifyPropertyChanged" +name = "EncryptSource" +sig = "bool EncryptSource(ref string backingField, string newValue, Action onPropertyChanged = null, [CallerMemberName] string propertyName = null)" +returns = "bool" +file = "SecureNotifyPropertyChanged.cs" + [[classes]] name = "StringHasher" ns = "FEx.Encryption" file = "StringHasher.cs" static = true +[[methods]] +parent = "StringHasher" +name = "EncryptString" +sig = "static string EncryptString(string key, string plainInput)" +returns = "string" +file = "StringHasher.cs" +static = true + +[[methods]] +parent = "StringHasher" +name = "DecryptString" +sig = "static string DecryptString(string key, string cipherText)" +returns = "string" +file = "StringHasher.cs" +static = true + [[interfaces]] name = "IFExEncryptionSettings" ns = "FEx.Encryption.Abstractions.Interfaces" file = "Abstractions\\Interfaces\\IFExEncryptionSettings.cs" +[[properties]] +parent = "IFExEncryptionSettings" +name = "PassPhrase" +sig = "string PassPhrase { get; }" +returns = "string" +file = "Abstractions\\Interfaces\\IFExEncryptionSettings.cs" + diff --git a/.api-surface/FEx/FTPx.toml b/.api-surface/FEx/FTPx.toml index 5697d08d..28b3cafd 100644 --- a/.api-surface/FEx/FTPx.toml +++ b/.api-surface/FEx/FTPx.toml @@ -7,12 +7,153 @@ name = "FtpClientFactory" ns = "FEx.FTPx" file = "FtpClientFactory.cs" +[[properties]] +parent = "FtpClientFactory" +name = "HostUri" +sig = "Uri HostUri { get; }" +returns = "Uri" +file = "FtpClientFactory.cs" + +[[properties]] +parent = "FtpClientFactory" +name = "ProxyCredentials" +sig = "ICredentials ProxyCredentials { get; set; }" +returns = "ICredentials" +file = "FtpClientFactory.cs" + +[[properties]] +parent = "FtpClientFactory" +name = "ProxyHost" +sig = "string ProxyHost { get; set; }" +returns = "string" +file = "FtpClientFactory.cs" + +[[properties]] +parent = "FtpClientFactory" +name = "ProxyPort" +sig = "int ProxyPort { get; set; }" +returns = "int" +file = "FtpClientFactory.cs" + +[[methods]] +parent = "FtpClientFactory" +name = "CreateAsync" +sig = "Task CreateAsync(string user = null, string pass = null, bool useProxy = false, int port = 0)" +returns = "Task" +file = "FtpClientFactory.cs" + +[[methods]] +parent = "FtpClientFactory" +name = "CreateAsync" +sig = "Task CreateAsync(string user = null, string pass = null, ProxyInfo proxy = null, int port = 0)" +returns = "Task" +file = "FtpClientFactory.cs" + +[[methods]] +parent = "FtpClientFactory" +name = "CreateAsync" +sig = "Task CreateAsync(NetworkCredential credentials = null, bool useProxy = false, int port = 0)" +returns = "Task" +file = "FtpClientFactory.cs" + +[[methods]] +parent = "FtpClientFactory" +name = "CreateAsync" +sig = "Task CreateAsync(NetworkCredential credentials = null, ProxyInfo proxy = null, int port = 0)" +returns = "Task" +file = "FtpClientFactory.cs" + +[[methods]] +parent = "FtpClientFactory" +name = "ReleaseClientAsync" +sig = "Task ReleaseClientAsync(FtpClient client)" +returns = "Task" +file = "FtpClientFactory.cs" + +[[methods]] +parent = "FtpClientFactory" +name = "OnValidateCertificate" +sig = "void OnValidateCertificate(FtpSslValidationEventArgs e)" +returns = "void" +file = "FtpClientFactory.cs" + +[[methods]] +parent = "FtpClientFactory" +name = "GetProxy" +sig = "ProxyInfo GetProxy(bool useProxy)" +returns = "ProxyInfo" +file = "FtpClientFactory.cs" + +[[methods]] +parent = "FtpClientFactory" +name = "GetInstanceAsync" +sig = "static Task GetInstanceAsync(string hostUri, int maxParallel = 5)" +returns = "Task" +file = "FtpClientFactory.cs" +static = true + [[classes]] name = "FtpCommon" ns = "FEx.FTPx" file = "FtpCommon.cs" static = true +[[methods]] +parent = "FtpCommon" +name = "GetFtpFileInfoAsync" +sig = "static Task GetFtpFileInfoAsync(string ftpfilepath, Uri ftphost, string username, string password, bool useProxy = false, int port = 0)" +returns = "Task" +file = "FtpCommon.cs" +static = true + +[[methods]] +parent = "FtpCommon" +name = "CreateAsync" +sig = "static Task CreateAsync(Uri ftphost, string username, string password, bool useProxy = false, int port = 0)" +returns = "Task" +file = "FtpCommon.cs" +static = true + +[[methods]] +parent = "FtpCommon" +name = "ReleaseAsync" +sig = "static Task ReleaseAsync(FtpClient client)" +returns = "Task" +file = "FtpCommon.cs" +static = true + +[[methods]] +parent = "FtpCommon" +name = "DownloadFileFtpAsync" +sig = "static Task DownloadFileFtpAsync(string inputdirpath, Uri ftphost, string ftpfilepath, string username, string password, IProgressAggregator viewModel = null, bool useProxy = false)" +returns = "Task" +file = "FtpCommon.cs" +static = true + +[[methods]] +parent = "FtpCommon" +name = "UploadFileFtpAsync" +sig = "static Task UploadFileFtpAsync(string inputfilepath, Uri ftphost, string ftpdirpath, string username, string password, Func onTargetExists, IProgressAggregator viewModel = null, bool useProxy = false)" +returns = "Task" +file = "FtpCommon.cs" +static = true + +[[methods]] +parent = "FtpCommon" +name = "GetListingAsync" +sig = "static Task GetListingAsync(string ftpdirpath, Uri ftphost, string username, string password, bool useProxy = false)" +returns = "Task" +file = "FtpCommon.cs" +static = true + +[[methods]] +parent = "FtpCommon" +name = "RunFtpAction" +sig = "static void RunFtpAction(Uri targetUrl, Action action, NetworkCredential credentials = null)" +returns = "void" +file = "FtpCommon.cs" +static = true + [[classes]] name = "FtpDownloader" ns = "FEx.FTPx" @@ -20,3 +161,37 @@ summary = "FTP download utilities with resume support." file = "FtpDownloader.cs" static = true +[[properties]] +parent = "FtpDownloader" +name = "StatusDescription" +sig = "static string StatusDescription { get; set; }" +returns = "string" +file = "FtpDownloader.cs" +static = true + +[[methods]] +parent = "FtpDownloader" +name = "DownloadFileAsync" +sig = "static Task DownloadFileAsync(string fileName, Uri serverUri, IProgressAggregator viewModel, string username = \"\", string password = \"\")" +returns = "Task" +file = "FtpDownloader.cs" +static = true + +[[methods]] +parent = "FtpDownloader" +name = "RestartDownloadFromServerAsync" +sig = "static Task RestartDownloadFromServerAsync(string fileName, Uri serverUri, IProgressAggregator viewModel, long offset = 0, string username = \"\", string password = \"\")" +returns = "Task" +summary = "Restarts the download from server." +file = "FtpDownloader.cs" +static = true + +[[methods]] +parent = "FtpDownloader" +name = "CalculateSizeAsync" +sig = "static Task CalculateSizeAsync(Uri serverUri, bool promptOnError = true, LengthType unit = LengthType.Megabytes, string username = \"\", string password = \"\")" +returns = "Task" +summary = "Calculates the size." +file = "FtpDownloader.cs" +static = true + diff --git a/.api-surface/FEx/FileSystem.Tests.toml b/.api-surface/FEx/FileSystem.Tests.toml index e13394f5..f9a9c2a3 100644 --- a/.api-surface/FEx/FileSystem.Tests.toml +++ b/.api-surface/FEx/FileSystem.Tests.toml @@ -7,8 +7,162 @@ name = "DirectoryWalkerSafeDeleteTests" ns = "FEx.FileSystem.Tests" file = "DirectoryWalkerSafeDeleteTests.cs" +[[methods]] +parent = "DirectoryWalkerSafeDeleteTests" +name = "SafeDelete_NonExistentDirectory_ReturnsTrue" +sig = "void SafeDelete_NonExistentDirectory_ReturnsTrue()" +returns = "void" +file = "DirectoryWalkerSafeDeleteTests.cs" + +[[methods]] +parent = "DirectoryWalkerSafeDeleteTests" +name = "SafeDelete_EmptyDirectory_NonRecursive_DeletesAndReturnsTrue" +sig = "void SafeDelete_EmptyDirectory_NonRecursive_DeletesAndReturnsTrue()" +returns = "void" +file = "DirectoryWalkerSafeDeleteTests.cs" + +[[methods]] +parent = "DirectoryWalkerSafeDeleteTests" +name = "SafeDelete_DirectoryWithFiles_NonRecursive_ReturnsFalse" +sig = "void SafeDelete_DirectoryWithFiles_NonRecursive_ReturnsFalse()" +returns = "void" +file = "DirectoryWalkerSafeDeleteTests.cs" + +[[methods]] +parent = "DirectoryWalkerSafeDeleteTests" +name = "SafeDelete_DirectoryWithFiles_Recursive_DeletesAllAndReturnsTrue" +sig = "void SafeDelete_DirectoryWithFiles_Recursive_DeletesAllAndReturnsTrue()" +returns = "void" +file = "DirectoryWalkerSafeDeleteTests.cs" + +[[methods]] +parent = "DirectoryWalkerSafeDeleteTests" +name = "SafeDelete_DirectoryWithNestedStructure_Recursive_DeletesAllAndReturnsTrue" +sig = "void SafeDelete_DirectoryWithNestedStructure_Recursive_DeletesAllAndReturnsTrue()" +returns = "void" +file = "DirectoryWalkerSafeDeleteTests.cs" + +[[methods]] +parent = "DirectoryWalkerSafeDeleteTests" +name = "SafeDelete_DirectoryWithLockedFile_Recursive_ReturnsFalseAndLeavesLockedFile" +sig = "void SafeDelete_DirectoryWithLockedFile_Recursive_ReturnsFalseAndLeavesLockedFile()" +returns = "void" +file = "DirectoryWalkerSafeDeleteTests.cs" + +[[methods]] +parent = "DirectoryWalkerSafeDeleteTests" +name = "SafeDelete_NonExistentFile_ReturnsTrue" +sig = "void SafeDelete_NonExistentFile_ReturnsTrue()" +returns = "void" +file = "DirectoryWalkerSafeDeleteTests.cs" + +[[methods]] +parent = "DirectoryWalkerSafeDeleteTests" +name = "SafeDelete_ExistingFile_DeletesAndReturnsTrue" +sig = "void SafeDelete_ExistingFile_DeletesAndReturnsTrue()" +returns = "void" +file = "DirectoryWalkerSafeDeleteTests.cs" + +[[methods]] +parent = "DirectoryWalkerSafeDeleteTests" +name = "SafeDelete_LockedFile_ReturnsFalse" +sig = "void SafeDelete_LockedFile_ReturnsFalse()" +returns = "void" +file = "DirectoryWalkerSafeDeleteTests.cs" + [[classes]] name = "GitWorktreeExtensionsTests" ns = "FEx.FileSystem.Tests" file = "GitWorktreeExtensionsTests.cs" +[[methods]] +parent = "GitWorktreeExtensionsTests" +name = "GetGitWorktreeKind_NullDirectory_ReturnsNone" +sig = "void GetGitWorktreeKind_NullDirectory_ReturnsNone()" +returns = "void" +file = "GitWorktreeExtensionsTests.cs" + +[[methods]] +parent = "GitWorktreeExtensionsTests" +name = "GetGitWorktreeKind_PlainDirectory_NoGitMarker_ReturnsNone" +sig = "void GetGitWorktreeKind_PlainDirectory_NoGitMarker_ReturnsNone()" +returns = "void" +file = "GitWorktreeExtensionsTests.cs" + +[[methods]] +parent = "GitWorktreeExtensionsTests" +name = "GetGitWorktreeKind_MainRepo_GitAsFolder_ReturnsNone" +sig = "void GetGitWorktreeKind_MainRepo_GitAsFolder_ReturnsNone()" +returns = "void" +file = "GitWorktreeExtensionsTests.cs" + +[[methods]] +parent = "GitWorktreeExtensionsTests" +name = "GetGitWorktreeKind_LinkedWorktree_RelativeGitdir_ReturnsWorktree" +sig = "void GetGitWorktreeKind_LinkedWorktree_RelativeGitdir_ReturnsWorktree()" +returns = "void" +file = "GitWorktreeExtensionsTests.cs" + +[[methods]] +parent = "GitWorktreeExtensionsTests" +name = "GetGitWorktreeKind_LinkedWorktree_AbsoluteGitdir_ReturnsWorktree" +sig = "void GetGitWorktreeKind_LinkedWorktree_AbsoluteGitdir_ReturnsWorktree()" +returns = "void" +file = "GitWorktreeExtensionsTests.cs" + +[[methods]] +parent = "GitWorktreeExtensionsTests" +name = "GetGitWorktreeKind_LinkedWorktree_WindowsBackslashes_ReturnsWorktree" +sig = "void GetGitWorktreeKind_LinkedWorktree_WindowsBackslashes_ReturnsWorktree()" +returns = "void" +file = "GitWorktreeExtensionsTests.cs" + +[[methods]] +parent = "GitWorktreeExtensionsTests" +name = "GetGitWorktreeKind_Submodule_ReturnsSubmodule" +sig = "void GetGitWorktreeKind_Submodule_ReturnsSubmodule()" +returns = "void" +file = "GitWorktreeExtensionsTests.cs" + +[[methods]] +parent = "GitWorktreeExtensionsTests" +name = "GetGitWorktreeKind_SubmoduleInsideWorktree_ReturnsSubmodule" +sig = "void GetGitWorktreeKind_SubmoduleInsideWorktree_ReturnsSubmodule()" +returns = "void" +file = "GitWorktreeExtensionsTests.cs" + +[[methods]] +parent = "GitWorktreeExtensionsTests" +name = "GetGitWorktreeKind_MalformedGitFile_NoPrefix_ReturnsNone" +sig = "void GetGitWorktreeKind_MalformedGitFile_NoPrefix_ReturnsNone()" +returns = "void" +file = "GitWorktreeExtensionsTests.cs" + +[[methods]] +parent = "GitWorktreeExtensionsTests" +name = "GetGitWorktreeKind_MultilineGitFile_FirstLineDetermines" +sig = "void GetGitWorktreeKind_MultilineGitFile_FirstLineDetermines()" +returns = "void" +file = "GitWorktreeExtensionsTests.cs" + +[[methods]] +parent = "GitWorktreeExtensionsTests" +name = "GetGitWorktreeKind_GitdirWithoutWorktreesOrModules_ReturnsNone" +sig = "void GetGitWorktreeKind_GitdirWithoutWorktreesOrModules_ReturnsNone()" +returns = "void" +file = "GitWorktreeExtensionsTests.cs" + +[[methods]] +parent = "GitWorktreeExtensionsTests" +name = "IsGitWorktree_OnLinkedWorktree_ReturnsTrue" +sig = "void IsGitWorktree_OnLinkedWorktree_ReturnsTrue()" +returns = "void" +file = "GitWorktreeExtensionsTests.cs" + +[[methods]] +parent = "GitWorktreeExtensionsTests" +name = "IsGitWorktree_OnSubmodule_ReturnsFalse" +sig = "void IsGitWorktree_OnSubmodule_ReturnsFalse()" +returns = "void" +file = "GitWorktreeExtensionsTests.cs" + diff --git a/.api-surface/FEx/FileSystem.toml b/.api-surface/FEx/FileSystem.toml index 820e3bf4..c3cada37 100644 --- a/.api-surface/FEx/FileSystem.toml +++ b/.api-surface/FEx/FileSystem.toml @@ -3,108 +3,96 @@ name = "FEx.FileSystem" path = "src\\FEx.FileSystem" [[classes]] -name = "DirectoryInfoEnumerationExtensions" +name = "DirectoryWalker" ns = "FEx.FileSystem" -summary = "Shim extension methods that allow the rest of the codebase (which expects ) to compile and work on older frameworks where that type does not exist (e.g. netstandard2.0/2.1). The implementation maps the subset of functionality that is possible to emulate via the existing overloads. Properties that have no equivalent are ignored." -file = "DirectoryInfoEnumerationExtensions.cs" +file = "DirectoryWalker.cs" static = true -[[extensions]] -name = "EnumerateFiles" -sig = "IEnumerable EnumerateFiles(this DirectoryInfo dir, - string searchPattern, - FExEnumerationOptions options)" -returns = "IEnumerable" -summary = "Shim extension methods that allow the rest of the codebase (which expects ) to compile and work on older frameworks where that type does not exist (e.g. netstandard2.0/2.1). The implementation maps the subset of functionality that is possible to emulate via the existing overloads. Properties that have no equivalent are ignored." -file = "DirectoryInfoEnumerationExtensions.cs" - -[[extensions]] -name = "EnumerateDirectories" -sig = "IEnumerable EnumerateDirectories(this DirectoryInfo dir, - string searchPattern, - FExEnumerationOptions options)" -returns = "IEnumerable" -summary = "Shim extension methods that allow the rest of the codebase (which expects ) to compile and work on older frameworks where that type does not exist (e.g. netstandard2.0/2.1). The implementation maps the subset of functionality that is possible to emulate via the existing overloads. Properties that have no equivalent are ignored." -file = "DirectoryInfoEnumerationExtensions.cs" +[[properties]] +parent = "DirectoryWalker" +name = "Limit" +sig = "static uint Limit { get; set; }" +returns = "uint" +file = "DirectoryWalker.cs" +static = true -[[extensions]] -name = "EnumerateFileSystemInfos" -sig = "IEnumerable EnumerateFileSystemInfos(this DirectoryInfo dir, - string searchPattern, - FExEnumerationOptions options)" -returns = "IEnumerable" -summary = "Shim extension methods that allow the rest of the codebase (which expects ) to compile and work on older frameworks where that type does not exist (e.g. netstandard2.0/2.1). The implementation maps the subset of functionality that is possible to emulate via the existing overloads. Properties that have no equivalent are ignored." -file = "DirectoryInfoEnumerationExtensions.cs" +[[methods]] +parent = "DirectoryWalker" +name = "SafeGetAllDirectoriesAsync" +sig = "static Task> SafeGetAllDirectoriesAsync(string rootPath, DirectoryFilterDelegate predicate = null, string searchPattern = \"*\", FExEnumerationOptions options = null, DirectoryFilterDelegate skipRecursionPredicate = null)" +returns = "Task>" +summary = "Recursively gets all subdirectories from a root directory, ignoring any directories that throw an or other IO exceptions." +file = "DirectoryWalker.cs" +static = true [[extensions]] -name = "GetDirectories" -sig = "DirectoryInfo[] GetDirectories(this DirectoryInfo dir, - string searchPattern, - FExEnumerationOptions options)" -returns = "DirectoryInfo[]" -summary = "Shim extension methods that allow the rest of the codebase (which expects ) to compile and work on older frameworks where that type does not exist (e.g. netstandard2.0/2.1). The implementation maps the subset of functionality that is possible to emulate via the existing overloads. Properties that have no equivalent are ignored." -file = "DirectoryInfoEnumerationExtensions.cs" - -[[classes]] -name = "DirectoryWalker" -ns = "FEx.FileSystem" +name = "SafeGetAllDirectoriesAsync" +returns = "Task>" +sig = "Task> SafeGetAllDirectoriesAsync(this DirectoryInfo root, DirectoryFilterDelegate predicate = null, string searchPattern = \"*\", FExEnumerationOptions options = null, DirectoryFilterDelegate skipRecursionPredicate = null)" +summary = "Recursively gets all subdirectories from a root directory, ignoring any directories that throw an UnauthorizedAccessException or other IO exceptions." file = "DirectoryWalker.cs" -static = true [[extensions]] name = "SafeGetAllFiles" -sig = "List SafeGetAllFiles(this DirectoryInfo root, - FileFilterDelegate predicate = null, - string searchPattern = \"*\", - FExEnumerationOptions options = null, - DirectoryFilterDelegate skipDirectoryPredicate = null)" returns = "List" -summary = "Recursively gets all subdirectories from a root directory, ignoring any directories that throw an UnauthorizedAccessException or other IO exceptions." +sig = "List SafeGetAllFiles(this DirectoryInfo root, FileFilterDelegate predicate = null, string searchPattern = \"*\", FExEnumerationOptions options = null, DirectoryFilterDelegate skipDirectoryPredicate = null)" file = "DirectoryWalker.cs" [[extensions]] name = "AddToErrorPaths" -sig = "void AddToErrorPaths(this DirectoryInfo folder)" returns = "void" +sig = "void AddToErrorPaths(this DirectoryInfo folder)" file = "DirectoryWalker.cs" [[extensions]] name = "IsErrorPath" -sig = "bool IsErrorPath(this DirectoryInfo folder)" returns = "bool" +sig = "bool IsErrorPath(this DirectoryInfo folder)" +file = "DirectoryWalker.cs" + +[[methods]] +parent = "DirectoryWalker" +name = "ClearErrorPaths" +sig = "static void ClearErrorPaths()" +returns = "void" +file = "DirectoryWalker.cs" +static = true + +[[extensions]] +name = "SafeGetLeafDirectoriesAsync" +returns = "Task>" +sig = "Task> SafeGetLeafDirectoriesAsync(this DirectoryInfo root, DirectoryFilterDelegate predicate = null, string searchPattern = \"*\", FExEnumerationOptions options = null, DirectoryFilterDelegate skipRecursionPredicate = null)" file = "DirectoryWalker.cs" [[extensions]] name = "GetTopLevelFolders" -sig = "List GetTopLevelFolders(this IList folders, bool logFindings = false)" returns = "List" +sig = "List GetTopLevelFolders(this IList folders, bool logFindings = false)" summary = "Given a list of folders, returns only those which are not subfolders of another folder in the list (\"top-level\" relative to each other)." file = "DirectoryWalker.cs" [[extensions]] name = "IsEmpty" -sig = "bool IsEmpty(this DirectoryInfo directory, - Func, bool> predicate = null)" returns = "bool" -summary = "Given a list of folders, returns only those which are not subfolders of another folder in the list (\"top-level\" relative to each other)." +sig = "bool IsEmpty(this DirectoryInfo directory, Func, bool> predicate = null)" file = "DirectoryWalker.cs" [[extensions]] name = "IsLeaf" -sig = "bool IsLeaf(this DirectoryInfo directory)" returns = "bool" +sig = "bool IsLeaf(this DirectoryInfo directory)" file = "DirectoryWalker.cs" [[extensions]] name = "SafeDelete" -sig = "bool SafeDelete(this DirectoryInfo folder, bool recursive = false, bool logDeletions = false)" returns = "bool" +sig = "bool SafeDelete(this DirectoryInfo folder, bool recursive = false, bool logDeletions = false)" file = "DirectoryWalker.cs" [[extensions]] name = "SafeDelete" -sig = "bool SafeDelete(this FileInfo file, bool logDeletions = false)" returns = "bool" +sig = "bool SafeDelete(this FileInfo file, bool logDeletions = false)" file = "DirectoryWalker.cs" [[classes]] @@ -113,15 +101,267 @@ ns = "FEx.FileSystem" summary = "Provides file and directory enumeration options." file = "FExEnumerationOptions.cs" +[[properties]] +parent = "FExEnumerationOptions" +name = "Compatible" +sig = "static FExEnumerationOptions Compatible { get; }" +returns = "FExEnumerationOptions" +summary = "For internal use. These are the options we want to use if calling the existing Directory/File APIs where you don't explicitly specify EnumerationOptions." +file = "FExEnumerationOptions.cs" +static = true + +[[properties]] +parent = "FExEnumerationOptions" +name = "CompatibleRecursive" +sig = "static FExEnumerationOptions CompatibleRecursive { get; }" +returns = "FExEnumerationOptions" +file = "FExEnumerationOptions.cs" +static = true + +[[ctors]] +parent = "FExEnumerationOptions" +sig = "FExEnumerationOptions()" +summary = "Initializes a new instance of the class with the recommended default options." +file = "FExEnumerationOptions.cs" + +[[properties]] +parent = "FExEnumerationOptions" +name = "RecurseSubdirectories" +sig = "bool RecurseSubdirectories { get; set; }" +returns = "bool" +summary = "Gets or sets a value that indicates whether to recurse into subdirectories while enumerating. The default is ." +file = "FExEnumerationOptions.cs" + +[[properties]] +parent = "FExEnumerationOptions" +name = "IgnoreInaccessible" +sig = "bool IgnoreInaccessible { get; set; }" +returns = "bool" +summary = "Gets or sets a value that indicates whether to skip files or directories when access is denied (for example, or ). The default is ." +file = "FExEnumerationOptions.cs" + +[[properties]] +parent = "FExEnumerationOptions" +name = "BufferSize" +sig = "int BufferSize { get; set; }" +returns = "int" +summary = "Gets or sets the suggested buffer size, in bytes. The default is 0 (no suggestion)." +file = "FExEnumerationOptions.cs" + +[[properties]] +parent = "FExEnumerationOptions" +name = "AttributesToSkip" +sig = "FileAttributes AttributesToSkip { get; set; }" +returns = "FileAttributes" +summary = "Gets or sets the attributes to skip. The default is FileAttributes.Hidden | FileAttributes.System ." +file = "FExEnumerationOptions.cs" + +[[properties]] +parent = "FExEnumerationOptions" +name = "CaseSensitive" +sig = "bool CaseSensitive { get; set; }" +returns = "bool" +summary = "Gets or sets whether to use case-sensitive matching." +file = "FExEnumerationOptions.cs" + +[[properties]] +parent = "FExEnumerationOptions" +name = "UseSimpleMatching" +sig = "bool UseSimpleMatching { get; set; }" +returns = "bool" +summary = "Gets or sets whether to use simple wildcard matching." +file = "FExEnumerationOptions.cs" + +[[properties]] +parent = "FExEnumerationOptions" +name = "MaxRecursionDepth" +sig = "int MaxRecursionDepth { get; set; }" +returns = "int" +summary = "Gets or sets a value that indicates the maximum directory depth to recurse while enumerating, when is set to ." +file = "FExEnumerationOptions.cs" + +[[properties]] +parent = "FExEnumerationOptions" +name = "ReturnSpecialDirectories" +sig = "bool ReturnSpecialDirectories { get; set; }" +returns = "bool" +summary = "Gets or sets a value that indicates whether to return the special directory entries \".\" and \"..\"." +file = "FExEnumerationOptions.cs" + +[[methods]] +parent = "FExEnumerationOptions" +name = "ToEnumerationOptions" +sig = "EnumerationOptions ToEnumerationOptions()" +returns = "EnumerationOptions" +summary = "Converts current instance to the runtime which is supported on net6.0+ and therefore on net9.0 that this solution targets." +file = "FExEnumerationOptions.cs" + [[classes]] name = "FileSystemUtilities" ns = "FEx.FileSystem" file = "FileSystemUtilities.cs" -[[classes]] -name = "GitWorktreeExtensions" -ns = "FEx.FileSystem" -file = "GitWorktreeExtensions.cs" +[[properties]] +parent = "FileSystemUtilities" +name = "Logger" +sig = "static ILogger Logger { get; }" +returns = "ILogger" +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "DirectoryPathStringToDirectoryInfo" +sig = "static Result DirectoryPathStringToDirectoryInfo(string source)" +returns = "Result" +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "ProcessDirectory" +sig = "static Result ProcessDirectory(string source, string dest, FileOperation fileOperation, bool printPaths = true, bool printLog = true, params string[] exclusionPaths)" +returns = "Result" +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "ProcessDirectory" +sig = "static Result ProcessDirectory(DirectoryInfo sourceInfo, DirectoryInfo dest, FileOperation fileOperation, bool printPaths = true, bool printLog = true, params string[] exclusionPaths)" +returns = "Result" +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "GetSourceFiles" +sig = "static ConcurrentList GetSourceFiles( ConcurrentDictionary sourceDirectories)" +returns = "ConcurrentList" +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "CreateMissingDestinationDirectories" +sig = "static Result CreateMissingDestinationDirectories(FileSystemInfo dest, ICollection sourcePaths)" +returns = "Result" +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "GetDirectoriesContents" +sig = "static Result, AggregatedError> GetDirectoriesContents( string source, string[] exclusionPaths)" +returns = "Result, AggregatedError>" +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "GetDirectoriesContents" +sig = "static Result, AggregatedError> GetDirectoriesContents( DirectoryInfo source, params string[] exclusionPaths)" +returns = "Result, AggregatedError>" +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "CopyFileAndSetAttributes" +sig = "static Result CopyFileAndSetAttributes(FileSystemInfo destDir, FileInfo sourceFile, bool printPaths, bool copyOnlyIfDifferent = false, bool printLog = true)" +returns = "Result" +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "MoveFileAndSetAttributes" +sig = "static Result MoveFileAndSetAttributes(FileSystemInfo destDir, FileInfo sourceFile, bool printPaths, bool printLog = true)" +returns = "Result" +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "SafeDeleteFile" +sig = "static Result SafeDeleteFile(string filePath, bool removeEmptyDirectory = false)" +returns = "Result" +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "SafeDeleteFile" +sig = "static Result SafeDeleteFile(FileInfo fileInfo, bool removeEmptyDirectory = false)" +returns = "Result" +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "DirectoryIsEmpty" +sig = "static bool DirectoryIsEmpty(string directoryPath)" +returns = "bool" +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "FixFileName" +sig = "static string FixFileName(string fileName)" +returns = "string" +summary = "Fixes the name of the file." +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "IsPathFile" +sig = "static Result IsPathFile(string path)" +returns = "Result" +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "GetEncoding" +sig = "static Encoding GetEncoding(string path, bool omitBom = false)" +returns = "Encoding" +summary = "Gets file encoding with or without Byte Order Mark" +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "OmitBom" +sig = "static Encoding OmitBom(Encoding enc)" +returns = "Encoding" +summary = "Omits the bom." +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "ReplaceStringInFileAsync" +sig = "static Task> ReplaceStringInFileAsync(FileInfo fileInfo, string oldValue, string newValue)" +returns = "Task>" +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "FileExistsSafe" +sig = "static bool FileExistsSafe(string path)" +returns = "bool" +file = "FileSystemUtilities.cs" +static = true + +[[methods]] +parent = "FileSystemUtilities" +name = "SafeDeleteDirectory" +sig = "static Result SafeDeleteDirectory(string source, bool printPaths = true, bool printLog = true, params string[] exclusionPaths)" +returns = "Result" +file = "FileSystemUtilities.cs" static = true [[enums]] @@ -129,16 +369,22 @@ name = "GitWorktreeKind" ns = "FEx.FileSystem" file = "GitWorktreeExtensions.cs" +[[classes]] +name = "GitWorktreeExtensions" +ns = "FEx.FileSystem" +file = "GitWorktreeExtensions.cs" +static = true + [[extensions]] name = "GetGitWorktreeKind" -sig = "GitWorktreeKind GetGitWorktreeKind(this DirectoryInfo dir)" returns = "GitWorktreeKind" +sig = "GitWorktreeKind GetGitWorktreeKind(this DirectoryInfo dir)" file = "GitWorktreeExtensions.cs" [[extensions]] name = "IsGitWorktree" -sig = "bool IsGitWorktree(this DirectoryInfo dir)" returns = "bool" +sig = "bool IsGitWorktree(this DirectoryInfo dir)" file = "GitWorktreeExtensions.cs" [[classes]] @@ -147,9 +393,31 @@ ns = "FEx.FileSystem.Helpers" file = "Helpers\\CompressionHelper.cs" static = true +[[extensions]] +name = "DecompressGZipAsync" +returns = "Task" +sig = "Task DecompressGZipAsync(this FileInfo fileToDecompress, string targetDirectory, string targetFileName)" +file = "Helpers\\CompressionHelper.cs" + [[extensions]] name = "VerifyGZip" -sig = "bool VerifyGZip(this FileInfo fileToDecompress)" returns = "bool" +sig = "bool VerifyGZip(this FileInfo fileToDecompress)" +file = "Helpers\\CompressionHelper.cs" + +[[methods]] +parent = "CompressionHelper" +name = "DecompressZip" +sig = "static void DecompressZip(string fileToDecompress, string targetDirectory, bool overwrite = false)" +returns = "void" file = "Helpers\\CompressionHelper.cs" +static = true + +[[methods]] +parent = "CompressionHelper" +name = "ListZipEntries" +sig = "static ZipArchiveEntry[] ListZipEntries(string zipPath)" +returns = "ZipArchiveEntry[]" +file = "Helpers\\CompressionHelper.cs" +static = true diff --git a/.api-surface/FEx/Flurlx.Newtonsoft.toml b/.api-surface/FEx/Flurlx.Newtonsoft.toml index 93f54826..c8aa1e4f 100644 --- a/.api-surface/FEx/Flurlx.Newtonsoft.toml +++ b/.api-surface/FEx/Flurlx.Newtonsoft.toml @@ -8,3 +8,11 @@ ns = "FEx.Flurlx.Newtonsoft" summary = "Opt-in FEx.Flurlx module that swaps the default System.Text.Json serializer for Newtonsoft.Json (with , matching the legacy FEx.Flurlx behavior). Register this instead of ." file = "FExFlurlxNewtonsoftModule.cs" +[[methods]] +parent = "FExFlurlxNewtonsoftModule" +name = "JsonSerializerFactory" +sig = "static ISerializer JsonSerializerFactory()" +returns = "ISerializer" +file = "FExFlurlxNewtonsoftModule.cs" +static = true + diff --git a/.api-surface/FEx/Flurlx.Tests.toml b/.api-surface/FEx/Flurlx.Tests.toml index 2a892c37..a2772ade 100644 --- a/.api-surface/FEx/Flurlx.Tests.toml +++ b/.api-surface/FEx/Flurlx.Tests.toml @@ -7,9 +7,159 @@ name = "FExPollyPolicyBuilderTests" ns = "FEx.Flurlx.Tests" file = "FExPollyPolicyBuilderTests.cs" +[[ctors]] +parent = "FExPollyPolicyBuilderTests" +sig = "FExPollyPolicyBuilderTests()" +file = "FExPollyPolicyBuilderTests.cs" + +[[methods]] +parent = "FExPollyPolicyBuilderTests" +name = "BuildFullSuitePolicy_WithDefaultConfig_CreatesPolicy" +sig = "void BuildFullSuitePolicy_WithDefaultConfig_CreatesPolicy()" +returns = "void" +file = "FExPollyPolicyBuilderTests.cs" + +[[methods]] +parent = "FExPollyPolicyBuilderTests" +name = "RetryPolicy_RetriesOnHttpRequestException" +sig = "Task RetryPolicy_RetriesOnHttpRequestException()" +returns = "Task" +file = "FExPollyPolicyBuilderTests.cs" + +[[methods]] +parent = "FExPollyPolicyBuilderTests" +name = "RetryPolicy_RetriesOn5xxStatusCodes" +sig = "Task RetryPolicy_RetriesOn5xxStatusCodes()" +returns = "Task" +file = "FExPollyPolicyBuilderTests.cs" + +[[methods]] +parent = "FExPollyPolicyBuilderTests" +name = "RetryPolicy_DoesNotRetryOn4xxStatusCodes" +sig = "Task RetryPolicy_DoesNotRetryOn4xxStatusCodes()" +returns = "Task" +file = "FExPollyPolicyBuilderTests.cs" + +[[methods]] +parent = "FExPollyPolicyBuilderTests" +name = "CircuitBreaker_OpensAfterConsecutiveFailures" +sig = "Task CircuitBreaker_OpensAfterConsecutiveFailures()" +returns = "Task" +file = "FExPollyPolicyBuilderTests.cs" + +[[methods]] +parent = "FExPollyPolicyBuilderTests" +name = "Timeout_CancelsLongRunningRequest" +sig = "Task Timeout_CancelsLongRunningRequest()" +returns = "Task" +file = "FExPollyPolicyBuilderTests.cs" + +[[methods]] +parent = "FExPollyPolicyBuilderTests" +name = "Bulkhead_LimitsConcurrentRequests" +sig = "Task Bulkhead_LimitsConcurrentRequests()" +returns = "Task" +file = "FExPollyPolicyBuilderTests.cs" + +[[methods]] +parent = "FExPollyPolicyBuilderTests" +name = "Fallback_ReturnsServiceUnavailableOnFailure" +sig = "Task Fallback_ReturnsServiceUnavailableOnFailure()" +returns = "Task" +file = "FExPollyPolicyBuilderTests.cs" + +[[methods]] +parent = "FExPollyPolicyBuilderTests" +name = "SlowApiDefaults_CreatesCorrectConfiguration" +sig = "void SlowApiDefaults_CreatesCorrectConfiguration()" +returns = "void" +file = "FExPollyPolicyBuilderTests.cs" + +[[methods]] +parent = "FExPollyPolicyBuilderTests" +name = "FastApiDefaults_CreatesCorrectConfiguration" +sig = "void FastApiDefaults_CreatesCorrectConfiguration()" +returns = "void" +file = "FExPollyPolicyBuilderTests.cs" + +[[methods]] +parent = "FExPollyPolicyBuilderTests" +name = "Logger_LogsRetryAttempts" +sig = "Task Logger_LogsRetryAttempts()" +returns = "Task" +file = "FExPollyPolicyBuilderTests.cs" + [[classes]] name = "FlurlApiBaseIntegrationTests" ns = "FEx.Flurlx.Tests" base = "IDisposable" file = "FlurlApiBaseIntegrationTests.cs" +[[ctors]] +parent = "FlurlApiBaseIntegrationTests" +sig = "FlurlApiBaseIntegrationTests()" +file = "FlurlApiBaseIntegrationTests.cs" + +[[methods]] +parent = "FlurlApiBaseIntegrationTests" +name = "GetResponseAsync_SuccessfulRequest_ReturnsData" +sig = "Task GetResponseAsync_SuccessfulRequest_ReturnsData()" +returns = "Task" +file = "FlurlApiBaseIntegrationTests.cs" + +[[methods]] +parent = "FlurlApiBaseIntegrationTests" +name = "GetResponseAsync_ServerError_RetriesAndSucceeds" +sig = "Task GetResponseAsync_ServerError_RetriesAndSucceeds()" +returns = "Task" +file = "FlurlApiBaseIntegrationTests.cs" + +[[methods]] +parent = "FlurlApiBaseIntegrationTests" +name = "GetResponseAsync_PersistentFailure_ThrowsException" +sig = "Task GetResponseAsync_PersistentFailure_ThrowsException()" +returns = "Task" +file = "FlurlApiBaseIntegrationTests.cs" + +[[methods]] +parent = "FlurlApiBaseIntegrationTests" +name = "PostResponseAsync_WithRequestBody_SendsCorrectData" +sig = "Task PostResponseAsync_WithRequestBody_SendsCorrectData()" +returns = "Task" +file = "FlurlApiBaseIntegrationTests.cs" + +[[methods]] +parent = "FlurlApiBaseIntegrationTests" +name = "GetResponseAsync_DtoWithDateOnly_DeserializesViaSystemTextJson" +sig = "Task GetResponseAsync_DtoWithDateOnly_DeserializesViaSystemTextJson()" +returns = "Task" +file = "FlurlApiBaseIntegrationTests.cs" + +[[methods]] +parent = "FlurlApiBaseIntegrationTests" +name = "GetResponseAsync_WithQueryParameters_AppendsCorrectly" +sig = "Task GetResponseAsync_WithQueryParameters_AppendsCorrectly()" +returns = "Task" +file = "FlurlApiBaseIntegrationTests.cs" + +[[methods]] +parent = "FlurlApiBaseIntegrationTests" +name = "GetResponseAsync_Timeout_ThrowsTimeoutException" +sig = "Task GetResponseAsync_Timeout_ThrowsTimeoutException()" +returns = "Task" +file = "FlurlApiBaseIntegrationTests.cs" + +[[methods]] +parent = "FlurlApiBaseIntegrationTests" +name = "GetResponseAsync_MultipleRequests_RespectsBulkhead" +sig = "Task GetResponseAsync_MultipleRequests_RespectsBulkhead()" +returns = "Task" +file = "FlurlApiBaseIntegrationTests.cs" + +[[methods]] +parent = "FlurlApiBaseIntegrationTests" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "FlurlApiBaseIntegrationTests.cs" + diff --git a/.api-surface/FEx/Flurlx.toml b/.api-surface/FEx/Flurlx.toml index 632ebc73..71957a63 100644 --- a/.api-surface/FEx/Flurlx.toml +++ b/.api-surface/FEx/Flurlx.toml @@ -9,6 +9,67 @@ base = "IReadOnlyCollection" summary = "A collection of FlurlCookies that can be attached to one or more FlurlRequests, either explicitly via WithCookies or implicitly via a CookieSession. Stores cookies received via Set-Cookie response headers." file = "FExCookieJar.cs" +[[properties]] +parent = "FExCookieJar" +name = "Count" +sig = "int Count { get; }" +returns = "int" +file = "FExCookieJar.cs" + +[[methods]] +parent = "FExCookieJar" +name = "GetEnumerator" +sig = "IEnumerator GetEnumerator()" +returns = "IEnumerator" +file = "FExCookieJar.cs" + +[[methods]] +parent = "FExCookieJar" +name = "AddOrReplace" +sig = "FExCookieJar AddOrReplace(string name, object value, string originUrl, DateTimeOffset? dateReceived)" +returns = "FExCookieJar" +summary = "Adds a cookie to the jar or replaces one with the same Name/Domain/Path. Throws FExInvalidCookieException if cookie is invalid." +file = "FExCookieJar.cs" + +[[methods]] +parent = "FExCookieJar" +name = "AddOrReplace" +sig = "FExCookieJar AddOrReplace(string name, object value, string originUrl)" +returns = "FExCookieJar" +file = "FExCookieJar.cs" + +[[methods]] +parent = "FExCookieJar" +name = "AddOrReplace" +sig = "FExCookieJar AddOrReplace(FlurlCookie cookie)" +returns = "FExCookieJar" +summary = "Adds a cookie to the jar or replaces one with the same Name/Domain/Path. Throws FExInvalidCookieException if cookie is invalid." +file = "FExCookieJar.cs" + +[[methods]] +parent = "FExCookieJar" +name = "TryAddOrReplace" +sig = "bool TryAddOrReplace(FlurlCookie cookie, out string reason)" +returns = "bool" +summary = "Adds a cookie to the jar or updates if one with the same Name/Domain/Path already exists, but only if it is valid and not expired." +file = "FExCookieJar.cs" + +[[methods]] +parent = "FExCookieJar" +name = "Remove" +sig = "FExCookieJar Remove(Func predicate)" +returns = "FExCookieJar" +summary = "Removes all cookies matching the given predicate." +file = "FExCookieJar.cs" + +[[methods]] +parent = "FExCookieJar" +name = "Clear" +sig = "FExCookieJar Clear()" +returns = "FExCookieJar" +summary = "Removes all cookies from this CookieJar" +file = "FExCookieJar.cs" + [[classes]] name = "FExInvalidCookieException" ns = "FEx.Flurlx" @@ -16,12 +77,30 @@ base = "Exception" summary = "Exception thrown when attempting to add or update an invalid FlurlCookie to a CookieJar." file = "FExCookieJar.cs" +[[ctors]] +parent = "FExInvalidCookieException" +sig = "FExInvalidCookieException(string reason)" +summary = "Creates a new FExInvalidCookieException." +file = "FExCookieJar.cs" + [[classes]] name = "FExFlurlx" ns = "FEx.Flurlx" base = "FExInitializable" file = "FExFlurlx.cs" +[[ctors]] +parent = "FExFlurlx" +sig = "FExFlurlx(IFlurlConfigurator configurator)" +file = "FExFlurlx.cs" + +[[methods]] +parent = "FExFlurlx" +name = "OnInitialize" +sig = "void OnInitialize()" +returns = "void" +file = "FExFlurlx.cs" + [[classes]] name = "FExFlurlxBaseModule" ns = "FEx.Flurlx" @@ -29,38 +108,51 @@ base = "InitializeModule" summary = "Serializer-agnostic FEx.Flurlx registrations (client, cache, resilience, configurator). Pick a serializer by registering a serializer module on top: the core (System.Text.Json, default) or the opt-in FEx.Flurlx.Newtonsoft module. Both supply an via factory." file = "FExFlurlxBaseModule.cs" +[[methods]] +parent = "FExFlurlxBaseModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExFlurlxContainer container, IServiceCollection services)" +returns = "void" +file = "FExFlurlxBaseModule.cs" + [[classes]] name = "FExFlurlxModule" ns = "FEx.Flurlx" summary = "Default FEx.Flurlx module: serializer-agnostic core registrations plus a System.Text.Json serializer ( with ). Zero Newtonsoft dependency. For Newtonsoft, register the FEx.Flurlx.Newtonsoft module instead of this one." file = "FExFlurlxModule.cs" +[[methods]] +parent = "FExFlurlxModule" +name = "JsonSerializerFactory" +sig = "static ISerializer JsonSerializerFactory()" +returns = "ISerializer" +file = "FExFlurlxModule.cs" +static = true + [[classes]] name = "FlurlConfigurator" ns = "FEx.Flurlx" base = "FExInitializable, IFlurlConfigurator" file = "FlurlConfigurator.cs" -[[classes]] -name = "IsExternalInit" -ns = "System.Runtime.CompilerServices" -file = "IsExternalInit.cs" -static = true - -[[interfaces]] -name = "IApiConfiguration" -ns = "FEx.Flurlx.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IApiConfiguration.cs" +[[ctors]] +parent = "FlurlConfigurator" +sig = "FlurlConfigurator(IApiConfiguration apiConfiguration, IFlurlClientCache flurlClientCache, IFExPollyPolicyBuilder policyBuilder, ISerializer jsonSerializer)" +file = "FlurlConfigurator.cs" -[[interfaces]] -name = "IFExFlurlxContainer" -ns = "FEx.Flurlx.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IFExFlurlxContainer.cs" +[[methods]] +parent = "FlurlConfigurator" +name = "GetClient" +sig = "IFlurlClient GetClient()" +returns = "IFlurlClient" +file = "FlurlConfigurator.cs" -[[interfaces]] -name = "IFlurlConfigurator" -ns = "FEx.Flurlx.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IFlurlConfigurator.cs" +[[methods]] +parent = "FlurlConfigurator" +name = "GetResiliencePolicy" +sig = "IAsyncPolicy GetResiliencePolicy()" +returns = "IAsyncPolicy" +file = "FlurlConfigurator.cs" [[classes]] name = "PollyPolicyConfiguration" @@ -68,6 +160,88 @@ ns = "FEx.Flurlx.Configuration" summary = "Configuration for Polly resilience policies." file = "Configuration\\PollyPolicyConfiguration.cs" +[[properties]] +parent = "PollyPolicyConfiguration" +name = "MaxRetryAttempts" +sig = "int MaxRetryAttempts { get; set; }" +returns = "int" +summary = "Maximum number of retry attempts before giving up. Default: 3 attempts" +file = "Configuration\\PollyPolicyConfiguration.cs" + +[[properties]] +parent = "PollyPolicyConfiguration" +name = "InitialRetryDelay" +sig = "TimeSpan InitialRetryDelay { get; set; }" +returns = "TimeSpan" +summary = "Initial delay before first retry. Subsequent retries use exponential backoff. Default: 1 second" +file = "Configuration\\PollyPolicyConfiguration.cs" + +[[properties]] +parent = "PollyPolicyConfiguration" +name = "RequestTimeout" +sig = "TimeSpan RequestTimeout { get; set; }" +returns = "TimeSpan" +summary = "Maximum timeout for a single HTTP request. Default: 30 seconds" +file = "Configuration\\PollyPolicyConfiguration.cs" + +[[properties]] +parent = "PollyPolicyConfiguration" +name = "CircuitBreakerFailureThreshold" +sig = "int CircuitBreakerFailureThreshold { get; set; }" +returns = "int" +summary = "Number of consecutive failures before opening the circuit breaker. Default: 5 failures" +file = "Configuration\\PollyPolicyConfiguration.cs" + +[[properties]] +parent = "PollyPolicyConfiguration" +name = "CircuitBreakerDuration" +sig = "TimeSpan CircuitBreakerDuration { get; set; }" +returns = "TimeSpan" +summary = "Duration the circuit breaker stays open before allowing test requests. Default: 1 minute" +file = "Configuration\\PollyPolicyConfiguration.cs" + +[[properties]] +parent = "PollyPolicyConfiguration" +name = "MaxParallelization" +sig = "int MaxParallelization { get; set; }" +returns = "int" +summary = "Maximum number of parallel requests allowed (Bulkhead limit). Essential for slow APIs to prevent overwhelming the endpoint. Default: 10 concurrent requests" +file = "Configuration\\PollyPolicyConfiguration.cs" + +[[properties]] +parent = "PollyPolicyConfiguration" +name = "MaxQueuingActions" +sig = "int MaxQueuingActions { get; set; }" +returns = "int" +summary = "Maximum number of requests that can be queued when Bulkhead limit is reached. Default: 20 queued actions" +file = "Configuration\\PollyPolicyConfiguration.cs" + +[[properties]] +parent = "PollyPolicyConfiguration" +name = "EnableFallback" +sig = "bool EnableFallback { get; set; }" +returns = "bool" +summary = "Enable fallback policy for graceful degradation (e.g., returning cached data). Default: true" +file = "Configuration\\PollyPolicyConfiguration.cs" + +[[methods]] +parent = "PollyPolicyConfiguration" +name = "SlowApiDefaults" +sig = "static PollyPolicyConfiguration SlowApiDefaults()" +returns = "PollyPolicyConfiguration" +summary = "Creates a default configuration optimized for slow APIs (e.g., Synology DSM)." +file = "Configuration\\PollyPolicyConfiguration.cs" +static = true + +[[methods]] +parent = "PollyPolicyConfiguration" +name = "FastApiDefaults" +sig = "static PollyPolicyConfiguration FastApiDefaults()" +returns = "PollyPolicyConfiguration" +summary = "Creates a default configuration optimized for fast, reliable APIs." +file = "Configuration\\PollyPolicyConfiguration.cs" +static = true + [[classes]] name = "FlurlExtensions" ns = "FEx.Flurlx.Extensions" @@ -76,20 +250,20 @@ static = true [[extensions]] name = "FixBooleanQueryParameters" -sig = "IFlurlRequest FixBooleanQueryParameters(this IFlurlRequest req)" returns = "IFlurlRequest" +sig = "IFlurlRequest FixBooleanQueryParameters(this IFlurlRequest req)" file = "Extensions\\FlurlExtensions.cs" [[extensions]] name = "FixBooleanQueryParameters" -sig = "Url FixBooleanQueryParameters(this Url url)" returns = "Url" +sig = "Url FixBooleanQueryParameters(this Url url)" file = "Extensions\\FlurlExtensions.cs" [[extensions]] name = "StripCharsetQuotes" -sig = "HttpContent StripCharsetQuotes(this HttpContent content)" returns = "HttpContent" +sig = "HttpContent StripCharsetQuotes(this HttpContent content)" file = "Extensions\\FlurlExtensions.cs" [[classes]] @@ -100,8 +274,8 @@ static = true [[extensions]] name = "IsSuccessStatusCode" -sig = "bool IsSuccessStatusCode(this IFlurlResponse response)" returns = "bool" +sig = "bool IsSuccessStatusCode(this IFlurlResponse response)" summary = "Gets a value that indicates if the HTTP response was successful." file = "Extensions\\FlurlResponseExtensions.cs" @@ -113,38 +287,50 @@ static = true [[extensions]] name = "CalculateSizeAsync" -sig = "Task CalculateSizeAsync(this Url url)" returns = "Task" +sig = "Task CalculateSizeAsync(this Url url)" file = "Extensions\\UrlExtensions.cs" [[extensions]] name = "CalculateSizeAsync" +returns = "Task" sig = "Task CalculateSizeAsync(this Url url, LengthType unit)" +file = "Extensions\\UrlExtensions.cs" + +[[extensions]] +name = "CalculateSizeAsync" returns = "Task" +sig = "Task CalculateSizeAsync(this Url url, LengthType unit, IFlurlClient client)" file = "Extensions\\UrlExtensions.cs" [[extensions]] name = "GetBytesAsync" -sig = "Task GetBytesAsync(this Url url)" returns = "Task" +sig = "Task GetBytesAsync(this Url url)" file = "Extensions\\UrlExtensions.cs" [[extensions]] name = "GetBytesAsync" -sig = "Task GetBytesAsync(this Url url, IFlurlClient client)" returns = "Task" +sig = "Task GetBytesAsync(this Url url, IFlurlClient client)" file = "Extensions\\UrlExtensions.cs" [[extensions]] name = "GetBytesAsync" -sig = "Task GetBytesAsync(this Url url, IFlurlClient client, SeekOrigin origin)" returns = "Task" +sig = "Task GetBytesAsync(this Url url, IFlurlClient client, SeekOrigin origin)" file = "Extensions\\UrlExtensions.cs" [[extensions]] name = "GetBytesAsync" +returns = "Task" sig = "Task GetBytesAsync(this Url url, IFlurlClient client, SeekOrigin origin, long offset)" +file = "Extensions\\UrlExtensions.cs" + +[[extensions]] +name = "GetBytesAsync" returns = "Task" +sig = "Task GetBytesAsync(this Url url, IFlurlClient client, SeekOrigin origin, long offset, long? length)" file = "Extensions\\UrlExtensions.cs" [[enums]] @@ -160,6 +346,19 @@ base = "IFExPollyPolicyBuilder" summary = "FEx Polly Policy Builder - Creates comprehensive resilience policies for HTTP requests." file = "Services\\FExPollyPolicyBuilder.cs" +[[ctors]] +parent = "FExPollyPolicyBuilder" +sig = "FExPollyPolicyBuilder(IFExLogger logger)" +file = "Services\\FExPollyPolicyBuilder.cs" + +[[methods]] +parent = "FExPollyPolicyBuilder" +name = "BuildFullSuitePolicy" +sig = "IAsyncPolicy BuildFullSuitePolicy(PollyPolicyConfiguration config)" +returns = "IAsyncPolicy" +summary = "Builds a comprehensive resilience policy with all Polly features." +file = "Services\\FExPollyPolicyBuilder.cs" + [[classes]] name = "FlurlApiBase" ns = "FEx.Flurlx.Services" @@ -167,8 +366,130 @@ base = "AsyncInitializable" summary = "Abstract base class for building typed API clients with Polly resilience." file = "Services\\FlurlApiBase.cs" +[[properties]] +parent = "FlurlApiBase" +name = "FlurlClient" +sig = "IFlurlClient FlurlClient { get; }" +returns = "IFlurlClient" +file = "Services\\FlurlApiBase.cs" + +[[properties]] +parent = "FlurlApiBase" +name = "ResiliencePolicy" +sig = "IAsyncPolicy ResiliencePolicy { get; }" +returns = "IAsyncPolicy" +file = "Services\\FlurlApiBase.cs" + +[[ctors]] +parent = "FlurlApiBase" +sig = "FlurlApiBase(IFlurlConfigurator flurlConfigurator)" +file = "Services\\FlurlApiBase.cs" + +[[methods]] +parent = "FlurlApiBase" +name = "GetStatusMessage" +sig = "static string GetStatusMessage(HttpStatusCode statusCode)" +returns = "string" +file = "Services\\FlurlApiBase.cs" +static = true + +[[methods]] +parent = "FlurlApiBase" +name = "IsSuccess" +sig = "static bool IsSuccess(IFlurlResponse response)" +returns = "bool" +file = "Services\\FlurlApiBase.cs" +static = true + +[[methods]] +parent = "FlurlApiBase" +name = "GetResponseAsync" +sig = "Task GetResponseAsync(string apiPath, Func func = null, RequestMethod method = RequestMethod.GET, TReq requestContent = default, CancellationToken cancellationToken = default)" +returns = "Task" +file = "Services\\FlurlApiBase.cs" + +[[methods]] +parent = "FlurlApiBase" +name = "AddConstantsToRequest" +sig = "IFlurlRequest AddConstantsToRequest(IFlurlRequest req)" +returns = "IFlurlRequest" +file = "Services\\FlurlApiBase.cs" + +[[methods]] +parent = "FlurlApiBase" +name = "GetResponseAsync" +sig = "Task GetResponseAsync(string apiPath, Func func = null, RequestMethod method = RequestMethod.GET, CancellationToken cancellationToken = default)" +returns = "Task" +file = "Services\\FlurlApiBase.cs" + [[interfaces]] name = "IFExPollyPolicyBuilder" ns = "FEx.Flurlx.Services" file = "Services\\IFExPollyPolicyBuilder.cs" +[[methods]] +parent = "IFExPollyPolicyBuilder" +name = "BuildFullSuitePolicy" +sig = "IAsyncPolicy BuildFullSuitePolicy(PollyPolicyConfiguration config)" +returns = "IAsyncPolicy" +file = "Services\\IFExPollyPolicyBuilder.cs" + +[[interfaces]] +name = "IApiConfiguration" +ns = "FEx.Flurlx.Abstractions.Interfaces" +file = "Abstractions\\Interfaces\\IApiConfiguration.cs" + +[[properties]] +parent = "IApiConfiguration" +name = "BaseUrl" +sig = "Url BaseUrl { get; }" +returns = "Url" +file = "Abstractions\\Interfaces\\IApiConfiguration.cs" + +[[properties]] +parent = "IApiConfiguration" +name = "ClientName" +sig = "string ClientName { get; }" +returns = "string" +file = "Abstractions\\Interfaces\\IApiConfiguration.cs" + +[[properties]] +parent = "IApiConfiguration" +name = "IgnoreSSLErrors" +sig = "bool IgnoreSSLErrors { get; }" +returns = "bool" +file = "Abstractions\\Interfaces\\IApiConfiguration.cs" + +[[properties]] +parent = "IApiConfiguration" +name = "PollyConfig" +sig = "PollyPolicyConfiguration PollyConfig { get; }" +returns = "PollyPolicyConfiguration" +file = "Abstractions\\Interfaces\\IApiConfiguration.cs" + +[[interfaces]] +name = "IFExFlurlxContainer" +ns = "FEx.Flurlx.Abstractions.Interfaces" +base = "IContainer, IContainer, IContainer, IContainer, IContainer" +file = "Abstractions\\Interfaces\\IFExFlurlxContainer.cs" + +[[interfaces]] +name = "IFlurlConfigurator" +ns = "FEx.Flurlx.Abstractions.Interfaces" +base = "IFExInitializable" +file = "Abstractions\\Interfaces\\IFlurlConfigurator.cs" + +[[methods]] +parent = "IFlurlConfigurator" +name = "GetClient" +sig = "IFlurlClient GetClient()" +returns = "IFlurlClient" +file = "Abstractions\\Interfaces\\IFlurlConfigurator.cs" + +[[methods]] +parent = "IFlurlConfigurator" +name = "GetResiliencePolicy" +sig = "IAsyncPolicy GetResiliencePolicy()" +returns = "IAsyncPolicy" +file = "Abstractions\\Interfaces\\IFlurlConfigurator.cs" + diff --git a/.api-surface/FEx/Imaging.Windows.toml b/.api-surface/FEx/Imaging.Windows.toml index dbc9f575..56bb11ad 100644 --- a/.api-surface/FEx/Imaging.Windows.toml +++ b/.api-surface/FEx/Imaging.Windows.toml @@ -5,8 +5,152 @@ path = "src\\Imaging.Windows" [[classes]] name = "CachedImage" ns = "FEx.Imaging.Windows" -base = "ReactiveNotifyPropertyChanged, IDisposable -#pragma warning restore IDISP025" +base = "ReactiveNotifyPropertyChanged, IDisposable" +file = "CachedImage.cs" + +[[properties]] +parent = "CachedImage" +name = "Cache" +sig = "FileInfo Cache { get; }" +returns = "FileInfo" +file = "CachedImage.cs" + +[[properties]] +parent = "CachedImage" +name = "CancellationTokenSource" +sig = "CancellationTokenSource CancellationTokenSource { get; }" +returns = "CancellationTokenSource" +file = "CachedImage.cs" + +[[properties]] +parent = "CachedImage" +name = "CancellationToken" +sig = "CancellationToken CancellationToken { get; }" +returns = "CancellationToken" +file = "CachedImage.cs" + +[[properties]] +parent = "CachedImage" +name = "CachedImages" +sig = "ConcurrentObservableDictionary CachedImages { get; }" +returns = "ConcurrentObservableDictionary" +file = "CachedImage.cs" + +[[properties]] +parent = "CachedImage" +name = "CachingTask" +sig = "Task CachingTask { get; set; }" +returns = "Task" +file = "CachedImage.cs" + +[[properties]] +parent = "CachedImage" +name = "ParentIndexEntry" +sig = "IndexEntry ParentIndexEntry { get; }" +returns = "IndexEntry" +file = "CachedImage.cs" + +[[properties]] +parent = "CachedImage" +name = "FileName" +sig = "string FileName { get; }" +returns = "string" +file = "CachedImage.cs" + +[[properties]] +parent = "CachedImage" +name = "Semaphore" +sig = "SemaphoreSlim Semaphore { get; }" +returns = "SemaphoreSlim" +file = "CachedImage.cs" + +[[properties]] +parent = "CachedImage" +name = "Url" +sig = "Uri Url { get; }" +returns = "Uri" +file = "CachedImage.cs" + +[[properties]] +parent = "CachedImage" +name = "FilesCacheDirPath" +sig = "string FilesCacheDirPath { get; }" +returns = "string" +file = "CachedImage.cs" + +[[properties]] +parent = "CachedImage" +name = "CacheValidTime" +sig = "TimeSpan? CacheValidTime { get; }" +returns = "TimeSpan?" +file = "CachedImage.cs" + +[[properties]] +parent = "CachedImage" +name = "Extension" +sig = "string Extension { get; set; }" +returns = "string" +file = "CachedImage.cs" + +[[properties]] +parent = "CachedImage" +name = "ResponseContentLength" +sig = "long ResponseContentLength { get; set; }" +returns = "long" +file = "CachedImage.cs" + +[[properties]] +parent = "CachedImage" +name = "IsDownloading" +sig = "bool IsDownloading { get; set; }" +returns = "bool" +file = "CachedImage.cs" + +[[ctors]] +parent = "CachedImage" +sig = "CachedImage(IndexEntry indexEntry, CancellationTokenSource cancellationTokenSource = default)" +file = "CachedImage.cs" + +[[methods]] +parent = "CachedImage" +name = "GetImageAsync" +sig = "Task GetImageAsync(WidthAndHeight size = null, WebRequestParams pars = null, bool refresh = false, bool forceLoad = false, bool forceMemoryStream = true, bool useHttpClientService = false, HttpWebResponse response = null)" +returns = "Task" +file = "CachedImage.cs" + +[[methods]] +parent = "CachedImage" +name = "PrepareCacheAsync" +sig = "Task PrepareCacheAsync(WebRequestParams pars = null, bool refresh = false, bool useHttpClientService = false, HttpWebResponse response = null, string checksum = null, Func urlModifier = null)" +returns = "Task" +file = "CachedImage.cs" + +[[methods]] +parent = "CachedImage" +name = "CacheIsInvalid" +sig = "bool CacheIsInvalid(bool refresh = false)" +returns = "bool" +file = "CachedImage.cs" + +[[methods]] +parent = "CachedImage" +name = "RemoveImageUpdate" +sig = "void RemoveImageUpdate(WidthAndHeight size = null)" +returns = "void" +file = "CachedImage.cs" + +[[methods]] +parent = "CachedImage" +name = "OnParentConfigurationChange" +sig = "void OnParentConfigurationChange()" +returns = "void" +file = "CachedImage.cs" + +[[methods]] +parent = "CachedImage" +name = "Dispose" +sig = "void Dispose()" +returns = "void" file = "CachedImage.cs" [[classes]] @@ -17,8 +161,8 @@ static = true [[extensions]] name = "DoesCacheExists" -sig = "bool DoesCacheExists(this IndexEntry entry)" returns = "bool" +sig = "bool DoesCacheExists(this IndexEntry entry)" file = "Extensions.cs" [[classes]] @@ -27,32 +171,460 @@ ns = "FEx.Imaging.Windows" base = "FilesCacheServiceConfig" file = "FExDefaultFilesCacheServiceConfig.cs" +[[ctors]] +parent = "FExDefaultFilesCacheServiceConfig" +sig = "FExDefaultFilesCacheServiceConfig(IAppInfoProvider appInfoProvider, DirectoryInfo imageCache = null, string sqlDbName = null, string sqliteDbFileName = null, bool useSqlite = false, bool useHttpClientService = false, TimeSpan? cacheValidPeriod = null, bool cacheAll = true)" +file = "FExDefaultFilesCacheServiceConfig.cs" + [[classes]] name = "FilesCacheDbService" ns = "FEx.Imaging.Windows" base = "EFCoreDatabaseBackedService" file = "FilesCacheDbService.cs" +[[ctors]] +parent = "FilesCacheDbService" +sig = "FilesCacheDbService(IScopeProvider scopeProvider, IFilesCacheServiceConfig config, ResilientTransaction resilientTransaction, ISqlDbHelper dbHelper, IAsyncInitializable[] dependencies)" +file = "FilesCacheDbService.cs" + [[classes]] name = "FilesCacheService" ns = "FEx.Imaging.Windows" base = "AsyncInitializable, IFilesCacheService" file = "FilesCacheService.cs" +[[properties]] +parent = "FilesCacheService" +name = "UseHttpClientService" +sig = "bool UseHttpClientService { get; }" +returns = "bool" +file = "FilesCacheService.cs" + +[[properties]] +parent = "FilesCacheService" +name = "Config" +sig = "IFilesCacheServiceConfig Config { get; }" +returns = "IFilesCacheServiceConfig" +file = "FilesCacheService.cs" + +[[properties]] +parent = "FilesCacheService" +name = "FilesCacheDir" +sig = "DirectoryInfo FilesCacheDir { get; }" +returns = "DirectoryInfo" +file = "FilesCacheService.cs" + +[[properties]] +parent = "FilesCacheService" +name = "FilesCacheIndex" +sig = "IndexEntriesCache FilesCacheIndex { get; }" +returns = "IndexEntriesCache" +file = "FilesCacheService.cs" + +[[properties]] +parent = "FilesCacheService" +name = "InitializationSemaphore" +sig = "SemaphoreSlim InitializationSemaphore { get; }" +returns = "SemaphoreSlim" +file = "FilesCacheService.cs" + +[[properties]] +parent = "FilesCacheService" +name = "LockSrv" +sig = "ISynchronizedAccessService LockSrv { get; }" +returns = "ISynchronizedAccessService" +file = "FilesCacheService.cs" + +[[ctors]] +parent = "FilesCacheService" +sig = "FilesCacheService(IFilesCacheServiceConfig config, IndexEntriesCache cache, ISynchronizedAccessService lockService)" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "EntryCacheShouldBePrepared" +sig = "bool EntryCacheShouldBePrepared(IIndexEntryBase entry, bool refresh)" +returns = "bool" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "GetFileChecksum" +sig = "string GetFileChecksum(Uri imageLink)" +returns = "string" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "GetFileSize" +sig = "long GetFileSize(Uri imageLink)" +returns = "long" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "GetFileName" +sig = "string GetFileName(Uri imageLink)" +returns = "string" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "GetEntryBaseAsync" +sig = "Task GetEntryBaseAsync(Uri fileUrl, bool addNew = true, string fileName = null)" +returns = "Task" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "PrepareCacheAndGetEntryBaseAsync" +sig = "Task PrepareCacheAndGetEntryBaseAsync( Uri fileUrl, WebRequestParams pars = null, bool refresh = false)" +returns = "Task" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "RemoveIndexEntriesAsync" +sig = "Task RemoveIndexEntriesAsync(params string[] ids)" +returns = "Task" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "CacheAllAsync" +sig = "Task CacheAllAsync(HashSet keys = null)" +returns = "Task" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "ContainsEntryAsync" +sig = "Task ContainsEntryAsync(Uri fileUrl)" +returns = "Task" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "PrepareCacheEntryAsync" +sig = "Task PrepareCacheEntryAsync(IIndexEntryBase entry, WebRequestParams pars = null, bool refresh = false, HttpWebResponse response = null, string checksum = null, Func urlModifier = null)" +returns = "Task" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "GetImageAsync" +sig = "Task GetImageAsync(Uri fileUrl, WidthAndHeight size = null, WebRequestParams pars = null, bool refresh = false, bool forceLoad = true, bool forceMemoryStream = false, HttpWebResponse response = null)" +returns = "Task" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "EntryCacheShouldBePrepared" +sig = "bool EntryCacheShouldBePrepared(IndexEntry entry, bool refresh)" +returns = "bool" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "RemoveImageUpdateAsync" +sig = "Task RemoveImageUpdateAsync(Uri fileUrl, WidthAndHeight size = null)" +returns = "Task" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "SetDefaultImageAsync" +sig = "Task SetDefaultImageAsync(Uri fileUrl, Bitmap defaultImage, ImageFormat format, string extension, bool force = false)" +returns = "Task" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "RemoveNotPresentFileUrlsAsync" +sig = "Task RemoveNotPresentFileUrlsAsync(HashSet urls)" +returns = "Task" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "IsFileBeingDownloadedAsync" +sig = "Task IsFileBeingDownloadedAsync(Uri fileUrl)" +returns = "Task" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "PrepareAndGetFileLocalUriAsync" +sig = "Task PrepareAndGetFileLocalUriAsync(Uri fileUrl, WebRequestParams pars = null, bool refresh = false, HttpWebResponse response = null)" +returns = "Task" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "IsFilePresentAsync" +sig = "Task IsFilePresentAsync(Uri fileUrl)" +returns = "Task" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "GetEntryAsync" +sig = "Task GetEntryAsync(Uri fileUrl, bool addNew = true, string fileName = null)" +returns = "Task" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "GetLazyImagesHandler" +sig = "LazyImagesHandler GetLazyImagesHandler()" +returns = "LazyImagesHandler" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "OptimizeCacheAsync" +sig = "Task> OptimizeCacheAsync()" +returns = "Task>" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "PrepareCacheAsync" +sig = "Task PrepareCacheAsync(Uri fileUrl, WebRequestParams pars = null, bool refresh = false, HttpWebResponse response = null, Func urlModifier = null)" +returns = "Task" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "PrepareCacheAndGetEntryAsync" +sig = "Task PrepareCacheAndGetEntryAsync(Uri fileUrl, WebRequestParams pars = null, bool refresh = false, HttpWebResponse response = null, Func urlModifier = null)" +returns = "Task" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "PrepareCacheEntryAsync" +sig = "Task PrepareCacheEntryAsync(WebRequestParams pars, bool refresh, HttpWebResponse response, IndexEntry entry, string checksum = null, Func urlModifier = null)" +returns = "Task" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "OnInitializeAsync" +sig = "Task OnInitializeAsync()" +returns = "Task" +file = "FilesCacheService.cs" + +[[methods]] +parent = "FilesCacheService" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +file = "FilesCacheService.cs" + [[classes]] name = "FilesCacheServiceConfig" ns = "FEx.Imaging.Windows" base = "IFilesCacheServiceConfig" file = "FilesCacheServiceConfig.cs" +[[properties]] +parent = "FilesCacheServiceConfig" +name = "DbServiceConfig" +sig = "IDbServiceConfig DbServiceConfig { get; }" +returns = "IDbServiceConfig" +file = "FilesCacheServiceConfig.cs" + +[[properties]] +parent = "FilesCacheServiceConfig" +name = "FilesCacheDir" +sig = "DirectoryInfo FilesCacheDir { get; }" +returns = "DirectoryInfo" +file = "FilesCacheServiceConfig.cs" + +[[properties]] +parent = "FilesCacheServiceConfig" +name = "FilesCacheDirPath" +sig = "string FilesCacheDirPath { get; }" +returns = "string" +file = "FilesCacheServiceConfig.cs" + +[[properties]] +parent = "FilesCacheServiceConfig" +name = "UseHttpClientService" +sig = "bool UseHttpClientService { get; }" +returns = "bool" +file = "FilesCacheServiceConfig.cs" + +[[properties]] +parent = "FilesCacheServiceConfig" +name = "CacheAll" +sig = "bool CacheAll { get; }" +returns = "bool" +file = "FilesCacheServiceConfig.cs" + +[[properties]] +parent = "FilesCacheServiceConfig" +name = "CacheValidPeriod" +sig = "TimeSpan? CacheValidPeriod { get; }" +returns = "TimeSpan?" +file = "FilesCacheServiceConfig.cs" + +[[ctors]] +parent = "FilesCacheServiceConfig" +sig = "FilesCacheServiceConfig(IDbServiceConfig dbServiceConfig, DirectoryInfo filesCacheDir, bool useHttpClientService = false, TimeSpan? cacheValidPeriod = null, bool cacheAll = true)" +file = "FilesCacheServiceConfig.cs" + [[interfaces]] name = "IFilesCacheService" ns = "FEx.Imaging.Windows" +base = "ICachedImageStorage, IAsyncInitializable" +file = "IFilesCacheService.cs" + +[[properties]] +parent = "IFilesCacheService" +name = "Config" +sig = "IFilesCacheServiceConfig Config { get; }" +returns = "IFilesCacheServiceConfig" +file = "IFilesCacheService.cs" + +[[properties]] +parent = "IFilesCacheService" +name = "FilesCacheDir" +sig = "DirectoryInfo FilesCacheDir { get; }" +returns = "DirectoryInfo" +file = "IFilesCacheService.cs" + +[[properties]] +parent = "IFilesCacheService" +name = "FilesCacheIndex" +sig = "IndexEntriesCache FilesCacheIndex { get; }" +returns = "IndexEntriesCache" +file = "IFilesCacheService.cs" + +[[properties]] +parent = "IFilesCacheService" +name = "UseHttpClientService" +sig = "bool UseHttpClientService { get; }" +returns = "bool" +file = "IFilesCacheService.cs" + +[[methods]] +parent = "IFilesCacheService" +name = "EntryCacheShouldBePrepared" +sig = "bool EntryCacheShouldBePrepared(IndexEntry entry, bool refresh)" +returns = "bool" +file = "IFilesCacheService.cs" + +[[methods]] +parent = "IFilesCacheService" +name = "GetEntryAsync" +sig = "Task GetEntryAsync(Uri fileUrl, bool addNew = true, string fileName = null)" +returns = "Task" +file = "IFilesCacheService.cs" + +[[methods]] +parent = "IFilesCacheService" +name = "PrepareAndGetFileLocalUriAsync" +sig = "Task PrepareAndGetFileLocalUriAsync(Uri fileUrl, WebRequestParams pars = null, bool refresh = false, HttpWebResponse response = null)" +returns = "Task" +file = "IFilesCacheService.cs" + +[[methods]] +parent = "IFilesCacheService" +name = "GetImageAsync" +sig = "Task GetImageAsync(Uri fileUrl, WidthAndHeight size = null, WebRequestParams pars = null, bool refresh = false, bool forceLoad = true, bool forceMemoryStream = false, HttpWebResponse response = null)" +returns = "Task" +file = "IFilesCacheService.cs" + +[[methods]] +parent = "IFilesCacheService" +name = "GetLazyImagesHandler" +sig = "LazyImagesHandler GetLazyImagesHandler()" +returns = "LazyImagesHandler" +file = "IFilesCacheService.cs" + +[[methods]] +parent = "IFilesCacheService" +name = "IsFileBeingDownloadedAsync" +sig = "Task IsFileBeingDownloadedAsync(Uri fileUrl)" +returns = "Task" +file = "IFilesCacheService.cs" + +[[methods]] +parent = "IFilesCacheService" +name = "IsFilePresentAsync" +sig = "Task IsFilePresentAsync(Uri fileUrl)" +returns = "Task" +file = "IFilesCacheService.cs" + +[[methods]] +parent = "IFilesCacheService" +name = "OptimizeCacheAsync" +sig = "Task> OptimizeCacheAsync()" +returns = "Task>" +file = "IFilesCacheService.cs" + +[[methods]] +parent = "IFilesCacheService" +name = "PrepareCacheAsync" +sig = "Task PrepareCacheAsync(Uri fileUrl, WebRequestParams pars = null, bool refresh = false, HttpWebResponse response = null, Func urlModifier = null)" +returns = "Task" +file = "IFilesCacheService.cs" + +[[methods]] +parent = "IFilesCacheService" +name = "PrepareCacheAndGetEntryAsync" +sig = "Task PrepareCacheAndGetEntryAsync(Uri fileUrl, WebRequestParams pars = null, bool refresh = false, HttpWebResponse response = null, Func urlModifier = null)" +returns = "Task" +file = "IFilesCacheService.cs" + +[[methods]] +parent = "IFilesCacheService" +name = "PrepareCacheEntryAsync" +sig = "Task PrepareCacheEntryAsync(WebRequestParams pars, bool refresh, HttpWebResponse response, IndexEntry entry, string checksum = null, Func urlModifier = null)" +returns = "Task" +file = "IFilesCacheService.cs" + +[[methods]] +parent = "IFilesCacheService" +name = "RemoveImageUpdateAsync" +sig = "Task RemoveImageUpdateAsync(Uri fileUrl, WidthAndHeight size = null)" +returns = "Task" +file = "IFilesCacheService.cs" + +[[methods]] +parent = "IFilesCacheService" +name = "SetDefaultImageAsync" +sig = "Task SetDefaultImageAsync(Uri fileUrl, Bitmap defaultImage, ImageFormat format, string extension, bool force = false)" +returns = "Task" +file = "IFilesCacheService.cs" + +[[methods]] +parent = "IFilesCacheService" +name = "RemoveNotPresentFileUrlsAsync" +sig = "Task RemoveNotPresentFileUrlsAsync(HashSet hashSet)" +returns = "Task" file = "IFilesCacheService.cs" [[interfaces]] name = "IFilesCacheServiceConfig" ns = "FEx.Imaging.Windows" +base = "IIndexEntryConfig" +file = "IFilesCacheServiceConfig.cs" + +[[properties]] +parent = "IFilesCacheServiceConfig" +name = "DbServiceConfig" +sig = "IDbServiceConfig DbServiceConfig { get; }" +returns = "IDbServiceConfig" +file = "IFilesCacheServiceConfig.cs" + +[[properties]] +parent = "IFilesCacheServiceConfig" +name = "CacheAll" +sig = "bool CacheAll { get; }" +returns = "bool" file = "IFilesCacheServiceConfig.cs" [[interfaces]] @@ -60,15 +632,105 @@ name = "IIndexEntryConfig" ns = "FEx.Imaging.Windows" file = "IIndexEntryConfig.cs" +[[properties]] +parent = "IIndexEntryConfig" +name = "FilesCacheDir" +sig = "DirectoryInfo FilesCacheDir { get; }" +returns = "DirectoryInfo" +file = "IIndexEntryConfig.cs" + +[[properties]] +parent = "IIndexEntryConfig" +name = "FilesCacheDirPath" +sig = "string FilesCacheDirPath { get; }" +returns = "string" +file = "IIndexEntryConfig.cs" + +[[properties]] +parent = "IIndexEntryConfig" +name = "UseHttpClientService" +sig = "bool UseHttpClientService { get; }" +returns = "bool" +file = "IIndexEntryConfig.cs" + +[[properties]] +parent = "IIndexEntryConfig" +name = "CacheValidPeriod" +sig = "TimeSpan? CacheValidPeriod { get; }" +returns = "TimeSpan?" +file = "IIndexEntryConfig.cs" + [[classes]] name = "IndexEntriesCache" ns = "FEx.Imaging.Windows" base = "SynchronizedDictionary" file = "IndexEntriesCache.cs" +[[properties]] +parent = "IndexEntriesCache" +name = "Config" +sig = "IIndexEntryConfig Config { get; }" +returns = "IIndexEntryConfig" +file = "IndexEntriesCache.cs" + +[[ctors]] +parent = "IndexEntriesCache" +sig = "IndexEntriesCache(IEFCoreDatabaseBackedService dbService, IIndexEntryConfig config, AsyncHelper asyncHelper)" +file = "IndexEntriesCache.cs" + +[[methods]] +parent = "IndexEntriesCache" +name = "GetOrAddValueAsync" +sig = "Task GetOrAddValueAsync(string key, bool addNew = true, string fileName = null)" +returns = "Task" +file = "IndexEntriesCache.cs" + +[[methods]] +parent = "IndexEntriesCache" +name = "RemoveIndexEntriesOfMissingFilesAsync" +sig = "Task RemoveIndexEntriesOfMissingFilesAsync(HashSet existingFiles)" +returns = "Task" +file = "IndexEntriesCache.cs" + +[[methods]] +parent = "IndexEntriesCache" +name = "RemoveIndexEntriesAsync" +sig = "Task RemoveIndexEntriesAsync(IDictionary entries)" +returns = "Task" +file = "IndexEntriesCache.cs" + +[[methods]] +parent = "IndexEntriesCache" +name = "RetriveKey" +sig = "Expression> RetriveKey()" +returns = "Expression>" +file = "IndexEntriesCache.cs" + +[[methods]] +parent = "IndexEntriesCache" +name = "DbSetAccessor" +sig = "DbSet DbSetAccessor(FilesCacheContext ctx)" +returns = "DbSet" +file = "IndexEntriesCache.cs" + +[[methods]] +parent = "IndexEntriesCache" +name = "GetNew" +sig = "IndexEntry GetNew(string key, IDictionary param = null)" +returns = "IndexEntry" +file = "IndexEntriesCache.cs" + +[[methods]] +parent = "IndexEntriesCache" +name = "OnRetrievedNew" +sig = "void OnRetrievedNew(IndexEntry value)" +returns = "void" +file = "IndexEntriesCache.cs" + [[interfaces]] name = "IWindowsImagingServicesModule" ns = "FEx.Imaging.Windows" +base = "IContainer, IContainer, IContainer, IContainer>, IContainer, IContainer" file = "IWindowsImagingServicesModule.cs" [[classes]] @@ -76,11 +738,160 @@ name = "LazyImagesHandler" ns = "FEx.Imaging.Windows" file = "LazyImagesHandler.cs" +[[properties]] +parent = "LazyImagesHandler" +name = "ImagesTasks" +sig = "ConcurrentObservableDictionary> ImagesTasks { get; }" +returns = "ConcurrentObservableDictionary>" +file = "LazyImagesHandler.cs" + +[[properties]] +parent = "LazyImagesHandler" +name = "Cache" +sig = "IFilesCacheService Cache { get; }" +returns = "IFilesCacheService" +file = "LazyImagesHandler.cs" + +[[ctors]] +parent = "LazyImagesHandler" +sig = "LazyImagesHandler(IFilesCacheService filesCacheService)" +file = "LazyImagesHandler.cs" + +[[methods]] +parent = "LazyImagesHandler" +name = "AnyOtherImageTaskIsRunning" +sig = "bool AnyOtherImageTaskIsRunning(string key)" +returns = "bool" +file = "LazyImagesHandler.cs" + +[[methods]] +parent = "LazyImagesHandler" +name = "GetImageTaskAsync" +sig = "Task GetImageTaskAsync(string propertyName)" +returns = "Task" +file = "LazyImagesHandler.cs" + +[[methods]] +parent = "LazyImagesHandler" +name = "AddEnsureImageTask" +sig = "bool AddEnsureImageTask(string propertyName, Uri imageUrl, Action imageSetAction, WidthAndHeight size = null, Action beforeAction = null, Action afterAction = null, WebRequestParams pars = null, bool refresh = false, bool forceLoad = true, bool forceMemoryStream = false)" +returns = "bool" +file = "LazyImagesHandler.cs" + [[classes]] name = "SizedImageCache" ns = "FEx.Imaging.Windows" -base = "NotifyPropertyChanged, IDisposable -#pragma warning restore IDISP025" +base = "NotifyPropertyChanged, IDisposable" +file = "SizedImageCache.cs" + +[[properties]] +parent = "SizedImageCache" +name = "CancellationTokenSource" +sig = "CancellationTokenSource CancellationTokenSource { get; }" +returns = "CancellationTokenSource" +file = "SizedImageCache.cs" + +[[properties]] +parent = "SizedImageCache" +name = "ImageUpdateAction" +sig = "Action ImageUpdateAction { get; set; }" +returns = "Action" +file = "SizedImageCache.cs" + +[[properties]] +parent = "SizedImageCache" +name = "ImageUpdateActionTask" +sig = "Task ImageUpdateActionTask { get; set; }" +returns = "Task" +file = "SizedImageCache.cs" + +[[properties]] +parent = "SizedImageCache" +name = "LoadingSemaphore" +sig = "SemaphoreSlim LoadingSemaphore { get; }" +returns = "SemaphoreSlim" +file = "SizedImageCache.cs" + +[[properties]] +parent = "SizedImageCache" +name = "CachedImage" +sig = "BitmapImage CachedImage { get; }" +returns = "BitmapImage" +file = "SizedImageCache.cs" + +[[properties]] +parent = "SizedImageCache" +name = "ImageSize" +sig = "WidthAndHeight ImageSize { get; }" +returns = "WidthAndHeight" +file = "SizedImageCache.cs" + +[[properties]] +parent = "SizedImageCache" +name = "IsLoadingImage" +sig = "bool IsLoadingImage { get; set; }" +returns = "bool" +file = "SizedImageCache.cs" + +[[properties]] +parent = "SizedImageCache" +name = "OwnCTS" +sig = "bool OwnCTS { get; }" +returns = "bool" +file = "SizedImageCache.cs" + +[[properties]] +parent = "SizedImageCache" +name = "Cache" +sig = "CachedImage Cache { get; }" +returns = "CachedImage" +file = "SizedImageCache.cs" + +[[properties]] +parent = "SizedImageCache" +name = "CacheFile" +sig = "FileInfo CacheFile { get; }" +returns = "FileInfo" +file = "SizedImageCache.cs" + +[[ctors]] +parent = "SizedImageCache" +sig = "SizedImageCache(CachedImage cachedImage, WidthAndHeight size = null, BitmapImage image = null, CancellationTokenSource cancellationTokenSource = default)" +file = "SizedImageCache.cs" + +[[methods]] +parent = "SizedImageCache" +name = "OnPropertyChanged" +sig = "void OnPropertyChanged([CallerMemberName] string propertyName = null)" +returns = "void" +file = "SizedImageCache.cs" + +[[methods]] +parent = "SizedImageCache" +name = "AddImageUpdateAction" +sig = "void AddImageUpdateAction(Action updateAction)" +returns = "void" +file = "SizedImageCache.cs" + +[[methods]] +parent = "SizedImageCache" +name = "RemoveImageUpdateAction" +sig = "void RemoveImageUpdateAction()" +returns = "void" +file = "SizedImageCache.cs" + +[[methods]] +parent = "SizedImageCache" +name = "ReloadImageFromCacheFileAsync" +sig = "Task ReloadImageFromCacheFileAsync(bool refresh = false, bool forceLoad = false, bool forceMemoryStream = true)" +returns = "Task" +file = "SizedImageCache.cs" + +[[methods]] +parent = "SizedImageCache" +name = "Dispose" +sig = "void Dispose()" +returns = "void" file = "SizedImageCache.cs" [[classes]] @@ -89,35 +900,240 @@ ns = "FEx.Imaging.Windows" base = "InitializeModule" file = "WindowsImagingServices.cs" +[[methods]] +parent = "WindowsImagingServices" +name = "RegisterServices" +sig = "void RegisterServices(IWindowsImagingServicesModule container, IServiceCollection services)" +returns = "void" +file = "WindowsImagingServices.cs" + [[classes]] name = "WindowsImagingServicesModule" ns = "FEx.Imaging.Windows" file = "WindowsImagingServicesModule.cs" +[[methods]] +parent = "WindowsImagingServicesModule" +name = "AddServices" +sig = "static void AddServices(IWindowsImagingServicesModule container, IServiceCollection services)" +returns = "void" +file = "WindowsImagingServicesModule.cs" +static = true + [[classes]] name = "InitialCreate" ns = "FEx.Imaging.Windows.Migrations" base = "Migration" file = "Migrations\\20191014120352_InitialCreate.cs" +[[methods]] +parent = "InitialCreate" +name = "Up" +sig = "void Up(MigrationBuilder migrationBuilder)" +returns = "void" +file = "Migrations\\20191014120352_InitialCreate.cs" + +[[methods]] +parent = "InitialCreate" +name = "Down" +sig = "void Down(MigrationBuilder migrationBuilder)" +returns = "void" +file = "Migrations\\20191014120352_InitialCreate.cs" + [[classes]] name = "Add_Size_Columns" ns = "FEx.Imaging.Windows.Migrations" base = "Migration" file = "Migrations\\20200610104919_Add_Size_Columns.cs" +[[methods]] +parent = "Add_Size_Columns" +name = "Up" +sig = "void Up(MigrationBuilder migrationBuilder)" +returns = "void" +file = "Migrations\\20200610104919_Add_Size_Columns.cs" + +[[methods]] +parent = "Add_Size_Columns" +name = "Down" +sig = "void Down(MigrationBuilder migrationBuilder)" +returns = "void" +file = "Migrations\\20200610104919_Add_Size_Columns.cs" + [[classes]] name = "FilesCacheContext" ns = "FEx.Imaging.Windows.Model" -base = "DbContext -// ReSharper restore PartialTypeWithSinglePart" +base = "DbContext" +file = "Model\\FilesCacheContext.cs" + +[[properties]] +parent = "FilesCacheContext" +name = "IndexEntries" +sig = "DbSet IndexEntries { get; set; }" +returns = "DbSet" +file = "Model\\FilesCacheContext.cs" + +[[ctors]] +parent = "FilesCacheContext" +sig = "FilesCacheContext(DbContextOptions options)" +file = "Model\\FilesCacheContext.cs" + +[[methods]] +parent = "FilesCacheContext" +name = "OnConfiguring" +sig = "void OnConfiguring(DbContextOptionsBuilder optionsBuilder)" +returns = "void" +file = "Model\\FilesCacheContext.cs" + +[[methods]] +parent = "FilesCacheContext" +name = "OnModelCreating" +sig = "void OnModelCreating(ModelBuilder modelBuilder)" +returns = "void" file = "Model\\FilesCacheContext.cs" [[classes]] name = "IndexEntry" ns = "FEx.Imaging.Windows.Model" -base = "IndexEntryBase, IDisposable -#pragma warning restore IDISP025" +base = "IndexEntryBase, IDisposable" +file = "Model\\IndexEntry.cs" + +[[properties]] +parent = "IndexEntry" +name = "Config" +sig = "IIndexEntryConfig Config { get; set; }" +returns = "IIndexEntryConfig" +file = "Model\\IndexEntry.cs" + +[[properties]] +parent = "IndexEntry" +name = "Url" +sig = "Uri Url { get; set; }" +returns = "Uri" +file = "Model\\IndexEntry.cs" + +[[properties]] +parent = "IndexEntry" +name = "FilesCacheRootDirPath" +sig = "string FilesCacheRootDirPath { get; set; }" +returns = "string" +file = "Model\\IndexEntry.cs" + +[[properties]] +parent = "IndexEntry" +name = "CachedImage" +sig = "CachedImage CachedImage { get; set; }" +returns = "CachedImage" +file = "Model\\IndexEntry.cs" + +[[properties]] +parent = "IndexEntry" +name = "Cache" +sig = "FileInfo Cache { get; set; }" +returns = "FileInfo" +file = "Model\\IndexEntry.cs" + +[[properties]] +parent = "IndexEntry" +name = "FileName" +sig = "string FileName { get; set; }" +returns = "string" +file = "Model\\IndexEntry.cs" + +[[properties]] +parent = "IndexEntry" +name = "Extension" +sig = "string Extension { get; set; }" +returns = "string" +file = "Model\\IndexEntry.cs" + +[[properties]] +parent = "IndexEntry" +name = "IsDownloading" +sig = "bool IsDownloading { get; set; }" +returns = "bool" +file = "Model\\IndexEntry.cs" + +[[properties]] +parent = "IndexEntry" +name = "Semaphore" +sig = "SemaphoreSlim Semaphore { get; set; }" +returns = "SemaphoreSlim" +file = "Model\\IndexEntry.cs" + +[[ctors]] +parent = "IndexEntry" +sig = "IndexEntry()" +file = "Model\\IndexEntry.cs" + +[[ctors]] +parent = "IndexEntry" +sig = "IndexEntry(string absoluteUri, IIndexEntryConfig config, string fileName = null)" +file = "Model\\IndexEntry.cs" + +[[methods]] +parent = "IndexEntry" +name = "GetFileName" +sig = "static string GetFileName(Uri url)" +returns = "string" +file = "Model\\IndexEntry.cs" +static = true + +[[methods]] +parent = "IndexEntry" +name = "GetFileName" +sig = "static string GetFileName(string uri)" +returns = "string" +file = "Model\\IndexEntry.cs" +static = true + +[[methods]] +parent = "IndexEntry" +name = "OnAbsoluteUriChange" +sig = "void OnAbsoluteUriChange()" +returns = "void" +file = "Model\\IndexEntry.cs" + +[[methods]] +parent = "IndexEntry" +name = "OnFilePathChange" +sig = "void OnFilePathChange()" +returns = "void" +file = "Model\\IndexEntry.cs" + +[[methods]] +parent = "IndexEntry" +name = "Refresh" +sig = "void Refresh()" +returns = "void" +file = "Model\\IndexEntry.cs" + +[[methods]] +parent = "IndexEntry" +name = "RefreshFileInfo" +sig = "void RefreshFileInfo()" +returns = "void" +file = "Model\\IndexEntry.cs" + +[[methods]] +parent = "IndexEntry" +name = "ResetCache" +sig = "void ResetCache()" +returns = "void" +file = "Model\\IndexEntry.cs" + +[[methods]] +parent = "IndexEntry" +name = "ResetCacheFile" +sig = "void ResetCacheFile(string filePath)" +returns = "void" +file = "Model\\IndexEntry.cs" + +[[methods]] +parent = "IndexEntry" +name = "Dispose" +sig = "void Dispose()" +returns = "void" file = "Model\\IndexEntry.cs" [[classes]] @@ -126,3 +1142,80 @@ ns = "FEx.Imaging.Windows.Model" base = "NotifyPropertyChanged, IIndexEntryBase" file = "Model\\IndexEntryBase.cs" +[[properties]] +parent = "IndexEntryBase" +name = "AbsoluteUri" +sig = "string AbsoluteUri { get; set; }" +returns = "string" +file = "Model\\IndexEntryBase.cs" + +[[properties]] +parent = "IndexEntryBase" +name = "CheckSum" +sig = "string CheckSum { get; set; }" +returns = "string" +file = "Model\\IndexEntryBase.cs" + +[[properties]] +parent = "IndexEntryBase" +name = "FilePath" +sig = "string FilePath { get; set; }" +returns = "string" +file = "Model\\IndexEntryBase.cs" + +[[properties]] +parent = "IndexEntryBase" +name = "ResponseContentLength" +sig = "long ResponseContentLength { get; set; }" +returns = "long" +file = "Model\\IndexEntryBase.cs" + +[[properties]] +parent = "IndexEntryBase" +name = "PixelHeight" +sig = "int PixelHeight { get; set; }" +returns = "int" +file = "Model\\IndexEntryBase.cs" + +[[properties]] +parent = "IndexEntryBase" +name = "PixelWidth" +sig = "int PixelWidth { get; set; }" +returns = "int" +file = "Model\\IndexEntryBase.cs" + +[[properties]] +parent = "IndexEntryBase" +name = "LocalUri" +sig = "Uri LocalUri { get; set; }" +returns = "Uri" +file = "Model\\IndexEntryBase.cs" + +[[methods]] +parent = "IndexEntryBase" +name = "Equals" +sig = "bool Equals(IIndexEntryBase other)" +returns = "bool" +file = "Model\\IndexEntryBase.cs" + +[[methods]] +parent = "IndexEntryBase" +name = "IsEqual" +sig = "bool IsEqual(IIndexEntryBase val)" +returns = "bool" +file = "Model\\IndexEntryBase.cs" + +[[methods]] +parent = "IndexEntryBase" +name = "OnAbsoluteUriChange" +sig = "void OnAbsoluteUriChange()" +returns = "void" +file = "Model\\IndexEntryBase.cs" + +[[methods]] +parent = "IndexEntryBase" +name = "OnFilePathChange" +sig = "void OnFilePathChange()" +returns = "void" +file = "Model\\IndexEntryBase.cs" + diff --git a/.api-surface/FEx/Json.toml b/.api-surface/FEx/Json.toml index a821c87e..b79e64bd 100644 --- a/.api-surface/FEx/Json.toml +++ b/.api-surface/FEx/Json.toml @@ -8,15 +8,43 @@ ns = "FEx.Json" base = "FExInitializable" file = "FExJson.cs" +[[ctors]] +parent = "FExJson" +sig = "FExJson(IContractResolver contractResolver)" +file = "FExJson.cs" + +[[methods]] +parent = "FExJson" +name = "OnInitialize" +sig = "void OnInitialize()" +returns = "void" +file = "FExJson.cs" + [[classes]] name = "FExJsonModule" ns = "FEx.Json" base = "InitializeModule" file = "FExJsonModule.cs" +[[methods]] +parent = "FExJsonModule" +name = "JsonSerializerSettingsFactory" +sig = "static JsonSerializerSettings JsonSerializerSettingsFactory()" +returns = "JsonSerializerSettings" +file = "FExJsonModule.cs" +static = true + +[[methods]] +parent = "FExJsonModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExJsonContainer container, IServiceCollection services)" +returns = "void" +file = "FExJsonModule.cs" + [[interfaces]] name = "IFExJsonContainer" ns = "FEx.Json" +base = "IContainer, IContainer, IContainer, IContainer" file = "IFExJsonContainer.cs" [[classes]] @@ -25,134 +53,306 @@ ns = "FEx.Json.Converters" base = "JsonConverter" file = "Converters\\JsonPathConverter.cs" +[[properties]] +parent = "JsonPathConverter" +name = "CanWrite" +sig = "bool CanWrite { get; }" +returns = "bool" +file = "Converters\\JsonPathConverter.cs" + +[[methods]] +parent = "JsonPathConverter" +name = "ReadJson" +sig = "object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)" +returns = "object" +file = "Converters\\JsonPathConverter.cs" + +[[methods]] +parent = "JsonPathConverter" +name = "CanConvert" +sig = "bool CanConvert(Type objectType)" +returns = "bool" +file = "Converters\\JsonPathConverter.cs" + +[[methods]] +parent = "JsonPathConverter" +name = "WriteJson" +sig = "void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)" +returns = "void" +file = "Converters\\JsonPathConverter.cs" + [[classes]] name = "ParseStringToDoubleConverter" ns = "FEx.Json.Converters" base = "JsonConverter" file = "Converters\\ParseStringToDoubleConverter.cs" +[[properties]] +parent = "ParseStringToDoubleConverter" +name = "Singleton" +sig = "static ParseStringToDoubleConverter Singleton { get; }" +returns = "ParseStringToDoubleConverter" +file = "Converters\\ParseStringToDoubleConverter.cs" +static = true + +[[methods]] +parent = "ParseStringToDoubleConverter" +name = "CanConvert" +sig = "bool CanConvert(Type t)" +returns = "bool" +file = "Converters\\ParseStringToDoubleConverter.cs" + +[[methods]] +parent = "ParseStringToDoubleConverter" +name = "ReadJson" +sig = "object ReadJson(JsonReader reader, Type t, object existingValue, JsonSerializer serializer)" +returns = "object" +file = "Converters\\ParseStringToDoubleConverter.cs" + +[[methods]] +parent = "ParseStringToDoubleConverter" +name = "WriteJson" +sig = "void WriteJson(JsonWriter writer, object untypedValue, JsonSerializer serializer)" +returns = "void" +file = "Converters\\ParseStringToDoubleConverter.cs" + [[classes]] name = "ParseStringToLongConverter" ns = "FEx.Json.Converters" base = "JsonConverter" file = "Converters\\ParseStringToLongConverter.cs" +[[properties]] +parent = "ParseStringToLongConverter" +name = "Singleton" +sig = "static ParseStringToLongConverter Singleton { get; }" +returns = "ParseStringToLongConverter" +file = "Converters\\ParseStringToLongConverter.cs" +static = true + +[[methods]] +parent = "ParseStringToLongConverter" +name = "CanConvert" +sig = "bool CanConvert(Type t)" +returns = "bool" +file = "Converters\\ParseStringToLongConverter.cs" + +[[methods]] +parent = "ParseStringToLongConverter" +name = "ReadJson" +sig = "object ReadJson(JsonReader reader, Type t, object existingValue, JsonSerializer serializer)" +returns = "object" +file = "Converters\\ParseStringToLongConverter.cs" + +[[methods]] +parent = "ParseStringToLongConverter" +name = "WriteJson" +sig = "void WriteJson(JsonWriter writer, object untypedValue, JsonSerializer serializer)" +returns = "void" +file = "Converters\\ParseStringToLongConverter.cs" + [[classes]] name = "JsonExtensions" ns = "FEx.Json.Extensions" file = "Extensions\\JsonExtensions.cs" static = true +[[properties]] +parent = "JsonExtensions" +name = "NullString" +sig = "static string NullString { get; }" +returns = "string" +file = "Extensions\\JsonExtensions.cs" +static = true + +[[properties]] +parent = "JsonExtensions" +name = "DefaultSettings" +sig = "static JsonSerializerSettings DefaultSettings { get; }" +returns = "JsonSerializerSettings" +file = "Extensions\\JsonExtensions.cs" +static = true + +[[methods]] +parent = "JsonExtensions" +name = "Initialize" +sig = "static void Initialize()" +returns = "void" +file = "Extensions\\JsonExtensions.cs" +static = true + +[[methods]] +parent = "JsonExtensions" +name = "ConfigureDefaultSettings" +sig = "static void ConfigureDefaultSettings(Action configuration)" +returns = "void" +file = "Extensions\\JsonExtensions.cs" +static = true + [[extensions]] name = "ToJson" -sig = "string ToJson(this object self, JsonSerializerSettings settings, Formatting formatting)" returns = "string" +sig = "string ToJson(this object self, JsonSerializerSettings settings, Formatting formatting)" file = "Extensions\\JsonExtensions.cs" [[extensions]] name = "ToJson" -sig = "string ToJson(this object self)" returns = "string" +sig = "string ToJson(this object self)" file = "Extensions\\JsonExtensions.cs" [[extensions]] name = "ToJson" -sig = "string ToJson(this object self, JsonSerializerSettings settings)" returns = "string" +sig = "string ToJson(this object self, JsonSerializerSettings settings)" file = "Extensions\\JsonExtensions.cs" [[extensions]] name = "ToJson" -sig = "string ToJson(this object self, Formatting formatting)" returns = "string" +sig = "string ToJson(this object self, Formatting formatting)" +file = "Extensions\\JsonExtensions.cs" + +[[extensions]] +name = "FromJson" +returns = "T" +sig = "T FromJson(this string json, JsonSerializerSettings settings, T fallback)" +file = "Extensions\\JsonExtensions.cs" + +[[extensions]] +name = "FromJson" +returns = "T" +sig = "T FromJson(this string json)" +file = "Extensions\\JsonExtensions.cs" + +[[extensions]] +name = "FromJson" +returns = "T" +sig = "T FromJson(this string json, JsonSerializerSettings settings)" file = "Extensions\\JsonExtensions.cs" [[extensions]] name = "FromJson" -sig = "object FromJson(this string json, JsonSerializerSettings settings)" returns = "object" +sig = "object FromJson(this string json, JsonSerializerSettings settings)" file = "Extensions\\JsonExtensions.cs" [[extensions]] name = "FromJson" -sig = "object FromJson(this string json)" returns = "object" +sig = "object FromJson(this string json)" file = "Extensions\\JsonExtensions.cs" [[extensions]] name = "DeserializeFromStream" -sig = "object DeserializeFromStream(this Stream stream, JsonSerializerSettings settings)" returns = "object" +sig = "object DeserializeFromStream(this Stream stream, JsonSerializerSettings settings)" file = "Extensions\\JsonExtensions.cs" [[extensions]] name = "DeserializeFromStream" -sig = "object DeserializeFromStream(this Stream stream)" returns = "object" +sig = "object DeserializeFromStream(this Stream stream)" +file = "Extensions\\JsonExtensions.cs" + +[[extensions]] +name = "DeserializeFromStream" +returns = "T" +sig = "T DeserializeFromStream(this Stream stream, JsonSerializerSettings settings)" +file = "Extensions\\JsonExtensions.cs" + +[[extensions]] +name = "DeserializeFromStream" +returns = "T" +sig = "T DeserializeFromStream(this Stream stream)" file = "Extensions\\JsonExtensions.cs" [[extensions]] name = "ReformatJson" -sig = "string ReformatJson(this string json)" returns = "string" +sig = "string ReformatJson(this string json)" summary = "Reformats the json." file = "Extensions\\JsonExtensions.cs" +[[extensions]] +name = "DeserializeToken" +returns = "T" +sig = "T DeserializeToken(this JToken jToken, JsonSerializerSettings settings)" +summary = "Deserializes the token." +file = "Extensions\\JsonExtensions.cs" + +[[extensions]] +name = "DeserializeToken" +returns = "T" +sig = "T DeserializeToken(this JToken jToken)" +file = "Extensions\\JsonExtensions.cs" + [[extensions]] name = "TrimJsonString" -sig = "string TrimJsonString(this string jsonValue)" returns = "string" -summary = "Deserializes the token." +sig = "string TrimJsonString(this string jsonValue)" file = "Extensions\\JsonExtensions.cs" +[[methods]] +parent = "JsonExtensions" +name = "PrettyPrintFile" +sig = "static void PrettyPrintFile(string orgPath, string destPath)" +returns = "void" +file = "Extensions\\JsonExtensions.cs" +static = true + [[extensions]] name = "PrettyPrintJson" -sig = "string PrettyPrintJson(this string json, - JsonLoadSettings loadSettings, - JsonSerializerSettings saveSettings, - Formatting formatting)" returns = "string" +sig = "string PrettyPrintJson(this string json, JsonLoadSettings loadSettings, JsonSerializerSettings saveSettings, Formatting formatting)" file = "Extensions\\JsonExtensions.cs" [[extensions]] name = "PrettyPrintJson" -sig = "string PrettyPrintJson(this string json)" returns = "string" +sig = "string PrettyPrintJson(this string json)" file = "Extensions\\JsonExtensions.cs" [[extensions]] name = "PrettyPrintJson" -sig = "string PrettyPrintJson(this string json, JsonLoadSettings loadSettings)" returns = "string" +sig = "string PrettyPrintJson(this string json, JsonLoadSettings loadSettings)" file = "Extensions\\JsonExtensions.cs" [[extensions]] name = "PrettyPrintJson" -sig = "string PrettyPrintJson(this string json, - JsonLoadSettings loadSettings, - JsonSerializerSettings saveSettings)" returns = "string" +sig = "string PrettyPrintJson(this string json, JsonLoadSettings loadSettings, JsonSerializerSettings saveSettings)" +file = "Extensions\\JsonExtensions.cs" + +[[extensions]] +name = "DeserializeFromFile" +returns = "T" +sig = "T DeserializeFromFile(this FileInfo file, JsonSerializerSettings settings)" +file = "Extensions\\JsonExtensions.cs" + +[[extensions]] +name = "DeserializeFromFile" +returns = "T" +sig = "T DeserializeFromFile(this FileInfo file)" file = "Extensions\\JsonExtensions.cs" [[extensions]] name = "SerializeToFile" -sig = "void SerializeToFile(this FileInfo file, - object self, - JsonSerializerSettings settings, - Formatting formatting)" returns = "void" +sig = "void SerializeToFile(this FileInfo file, object self, JsonSerializerSettings settings, Formatting formatting)" file = "Extensions\\JsonExtensions.cs" [[extensions]] name = "SerializeToFile" -sig = "void SerializeToFile(this FileInfo file, object self)" returns = "void" +sig = "void SerializeToFile(this FileInfo file, object self)" file = "Extensions\\JsonExtensions.cs" [[extensions]] name = "SerializeToFile" -sig = "void SerializeToFile(this FileInfo file, object self, JsonSerializerSettings settings)" returns = "void" +sig = "void SerializeToFile(this FileInfo file, object self, JsonSerializerSettings settings)" file = "Extensions\\JsonExtensions.cs" [[classes]] @@ -161,21 +361,98 @@ ns = "FEx.Json.Extensions" file = "Extensions\\NotifyPropertyChangedExtensions.cs" static = true +[[extensions]] +name = "SetPropertyAndDeserializeIt" +returns = "bool" +sig = "bool SetPropertyAndDeserializeIt(this IFExNotifyPropertyChanged obj, ref string backingField, string jsonValue, Action onDeserializedAction = null, JsonSerializerSettings settings = null, [CallerMemberName] string propertyName = null)" +file = "Extensions\\NotifyPropertyChangedExtensions.cs" + [[classes]] name = "DIMeta" ns = "FEx.Json.Helpers" base = "InitializeOnlyModule" file = "Helpers\\DIMeta.cs" +[[ctors]] +parent = "DIMeta" +sig = "DIMeta()" +file = "Helpers\\DIMeta.cs" + +[[methods]] +parent = "DIMeta" +name = "OnCompleteInitializationAsync" +sig = "ValueTask OnCompleteInitializationAsync(IServiceCollection services)" +returns = "ValueTask" +file = "Helpers\\DIMeta.cs" + +[[methods]] +parent = "DIMeta" +name = "IsRegistred" +sig = "bool IsRegistred(Type t)" +returns = "bool" +file = "Helpers\\DIMeta.cs" + +[[methods]] +parent = "DIMeta" +name = "RegistredTypeFor" +sig = "Type RegistredTypeFor(Type t)" +returns = "Type" +file = "Helpers\\DIMeta.cs" + +[[methods]] +parent = "DIMeta" +name = "RegisterServices" +sig = "void RegisterServices(object container, IServiceCollection services)" +returns = "void" +file = "Helpers\\DIMeta.cs" + [[classes]] name = "DIContractResolver" ns = "FEx.Json.Resolvers" base = "DefaultContractResolver" file = "Resolvers\\DIContractResolver.cs" +[[ctors]] +parent = "DIContractResolver" +sig = "DIContractResolver(DIMeta diMeta)" +file = "Resolvers\\DIContractResolver.cs" + +[[methods]] +parent = "DIContractResolver" +name = "CreateObjectContract" +sig = "JsonObjectContract CreateObjectContract(Type objectType)" +returns = "JsonObjectContract" +file = "Resolvers\\DIContractResolver.cs" + [[classes]] name = "PropertyRenameAndIgnoreSerializerContractResolver" ns = "FEx.Json.Resolvers" base = "DefaultContractResolver" file = "Resolvers\\PropertyRenameAndIgnoreSerializerContractResolver.cs" +[[ctors]] +parent = "PropertyRenameAndIgnoreSerializerContractResolver" +sig = "PropertyRenameAndIgnoreSerializerContractResolver()" +file = "Resolvers\\PropertyRenameAndIgnoreSerializerContractResolver.cs" + +[[methods]] +parent = "PropertyRenameAndIgnoreSerializerContractResolver" +name = "IgnoreProperty" +sig = "void IgnoreProperty(Type type, params string[] jsonPropertyNames)" +returns = "void" +file = "Resolvers\\PropertyRenameAndIgnoreSerializerContractResolver.cs" + +[[methods]] +parent = "PropertyRenameAndIgnoreSerializerContractResolver" +name = "RenameProperty" +sig = "void RenameProperty(Type type, string propertyName, string newJsonPropertyName)" +returns = "void" +file = "Resolvers\\PropertyRenameAndIgnoreSerializerContractResolver.cs" + +[[methods]] +parent = "PropertyRenameAndIgnoreSerializerContractResolver" +name = "CreateProperty" +sig = "JsonProperty CreateProperty(MemberInfo member, MemberSerialization memberSerialization)" +returns = "JsonProperty" +file = "Resolvers\\PropertyRenameAndIgnoreSerializerContractResolver.cs" + diff --git a/.api-surface/FEx/KeyVault.toml b/.api-surface/FEx/KeyVault.toml index c0777f00..43eddd1f 100644 --- a/.api-surface/FEx/KeyVault.toml +++ b/.api-surface/FEx/KeyVault.toml @@ -7,14 +7,51 @@ name = "IKeyVaultCredentials" ns = "FEx.KeyVault" file = "IKeyVaultCredentials.cs" +[[properties]] +parent = "IKeyVaultCredentials" +name = "AzureADTenantId" +sig = "string AzureADTenantId { get; }" +returns = "string" +file = "IKeyVaultCredentials.cs" + +[[properties]] +parent = "IKeyVaultCredentials" +name = "AzureADClientId" +sig = "string AzureADClientId { get; }" +returns = "string" +file = "IKeyVaultCredentials.cs" + +[[properties]] +parent = "IKeyVaultCredentials" +name = "KeyVaultName" +sig = "string KeyVaultName { get; }" +returns = "string" +file = "IKeyVaultCredentials.cs" + [[interfaces]] name = "IKeyVaultByCertCredentials" ns = "FEx.KeyVault" +base = "IKeyVaultCredentials" +file = "IKeyVaultCredentials.cs" + +[[properties]] +parent = "IKeyVaultByCertCredentials" +name = "AzureADCertThumbprint" +sig = "string AzureADCertThumbprint { get; }" +returns = "string" file = "IKeyVaultCredentials.cs" [[interfaces]] name = "IKeyVaultByClientSecretCredentials" ns = "FEx.KeyVault" +base = "IKeyVaultCredentials" +file = "IKeyVaultCredentials.cs" + +[[properties]] +parent = "IKeyVaultByClientSecretCredentials" +name = "AzureADClientSecret" +sig = "string AzureADClientSecret { get; }" +returns = "string" file = "IKeyVaultCredentials.cs" [[classes]] @@ -25,16 +62,14 @@ static = true [[extensions]] name = "AddAzureKeyVaultWithCertificate" -sig = "void AddAzureKeyVaultWithCertificate(this IConfigurationBuilder config, - IKeyVaultByCertCredentials credentials)" returns = "void" +sig = "void AddAzureKeyVaultWithCertificate(this IConfigurationBuilder config, IKeyVaultByCertCredentials credentials)" file = "KeyVaultConfigurator.cs" [[extensions]] name = "AddAzureKeyVaultWithClientSecret" -sig = "void AddAzureKeyVaultWithClientSecret(this IConfigurationBuilder config, - IKeyVaultByClientSecretCredentials credentials)" returns = "void" +sig = "void AddAzureKeyVaultWithClientSecret(this IConfigurationBuilder config, IKeyVaultByClientSecretCredentials credentials)" file = "KeyVaultConfigurator.cs" [[classes]] @@ -43,3 +78,40 @@ ns = "FEx.KeyVault" base = "IKeyVaultByCertCredentials, IKeyVaultByClientSecretCredentials" file = "KeyVaultCredentials.cs" +[[properties]] +parent = "KeyVaultCredentials" +name = "KeyVaultName" +sig = "string KeyVaultName { get; set; }" +returns = "string" +file = "KeyVaultCredentials.cs" + +[[properties]] +parent = "KeyVaultCredentials" +name = "AzureADTenantId" +sig = "string AzureADTenantId { get; set; }" +returns = "string" +summary = "Gets or sets the Directory (tenant) ID" +file = "KeyVaultCredentials.cs" + +[[properties]] +parent = "KeyVaultCredentials" +name = "AzureADClientId" +sig = "string AzureADClientId { get; set; }" +returns = "string" +summary = "Gets or sets the Application (client) ID" +file = "KeyVaultCredentials.cs" + +[[properties]] +parent = "KeyVaultCredentials" +name = "AzureADCertThumbprint" +sig = "string AzureADCertThumbprint { get; set; }" +returns = "string" +file = "KeyVaultCredentials.cs" + +[[properties]] +parent = "KeyVaultCredentials" +name = "AzureADClientSecret" +sig = "string AzureADClientSecret { get; set; }" +returns = "string" +file = "KeyVaultCredentials.cs" + diff --git a/.api-surface/FEx/Legacy.toml b/.api-surface/FEx/Legacy.toml index b3cc6b3b..85a9268c 100644 --- a/.api-surface/FEx/Legacy.toml +++ b/.api-surface/FEx/Legacy.toml @@ -8,15 +8,30 @@ ns = "FEx.Legacy" base = "FExInitializable" file = "FExLegacy.cs" +[[methods]] +parent = "FExLegacy" +name = "OnInitialize" +sig = "void OnInitialize()" +returns = "void" +file = "FExLegacy.cs" + [[classes]] name = "FExLegacyModule" ns = "FEx.Legacy" base = "InitializeModule" file = "FExLegacyModule.cs" +[[methods]] +parent = "FExLegacyModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExLegacyContainer container, IServiceCollection services)" +returns = "void" +file = "FExLegacyModule.cs" + [[interfaces]] name = "IFExLegacyContainer" ns = "FEx.Legacy" +base = "IContainer, IContainer" file = "IFExLegacyContainer.cs" [[classes]] @@ -25,101 +40,96 @@ ns = "FEx.Legacy.Asyncx" base = "ITasksHandler" file = "Asyncx\\TasksHandler.cs" -[[interfaces]] -name = "ITasksHandler" -ns = "FEx.Legacy.Asyncx.Abstractions.Interfaces" -file = "Asyncx\\Abstractions\\Interfaces\\ITasksHandler.cs" - -[[classes]] -name = "JobSpecsExtensions" -ns = "FEx.Legacy.Asyncx.Enums" -file = "Asyncx\\Enums\\JobSpecs.cs" -static = true - -[[enums]] -name = "JobSpecs" -ns = "FEx.Legacy.Asyncx.Enums" -file = "Asyncx\\Enums\\JobSpecs.cs" - -[[extensions]] -name = "HasFlagsFast" -sig = "bool HasFlagsFast(this JobSpecs? value, params JobSpecs[] flags)" -returns = "bool" -file = "Asyncx\\Enums\\JobSpecs.cs" - -[[extensions]] -name = "HasFlagFast" -sig = "bool HasFlagFast(this JobSpecs? value, JobSpecs flag)" -returns = "bool" -file = "Asyncx\\Enums\\JobSpecs.cs" - -[[classes]] -name = "TasksHandlerExtensions" -ns = "FEx.Legacy.Asyncx.Extensions" -file = "Asyncx\\Extensions\\TasksHandlerExtensions.cs" -static = true +[[ctors]] +parent = "TasksHandler" +sig = "TasksHandler(IAsyncHelper asyncHelper, ITasksInfoSubject tasksInfoSubject)" +file = "Asyncx\\TasksHandler.cs" -[[extensions]] +[[methods]] +parent = "TasksHandler" name = "RunAsync" -sig = "Task RunAsync(this ITasksHandler handler, Action task)" +sig = "Task RunAsync(Action task, JobSpecs? specs, Action pre, Action post, AsyncMode asyncMode, CancellationToken cancellationToken)" returns = "Task" -file = "Asyncx\\Extensions\\TasksHandlerExtensions.cs" +file = "Asyncx\\TasksHandler.cs" -[[extensions]] +[[methods]] +parent = "TasksHandler" name = "RunTaskAsync" -sig = "Task RunTaskAsync(this ITasksHandler handler, Func task)" -returns = "Task" -file = "Asyncx\\Extensions\\TasksHandlerExtensions.cs" +sig = "Task RunTaskAsync(Func> task, JobSpecs? specs, Action pre, Action post, AsyncMode asyncMode)" +returns = "Task" +file = "Asyncx\\TasksHandler.cs" -[[interfaces]] -name = "ICachedImageStorage" -ns = "FEx.Legacy.Imaging.Abstractions.Interfaces" -file = "Imaging\\Abstractions\\Interfaces\\ICachedImageStorage.cs" +[[methods]] +parent = "TasksHandler" +name = "RunFuncAsync" +sig = "Task RunFuncAsync(Func task, JobSpecs? specs, Action pre, Action post, AsyncMode asyncMode, CancellationToken cancellationToken)" +returns = "Task" +file = "Asyncx\\TasksHandler.cs" -[[interfaces]] -name = "IIndexEntryBase" -ns = "FEx.Legacy.Imaging.Abstractions.Interfaces" -file = "Imaging\\Abstractions\\Interfaces\\IIndexEntryBase.cs" +[[methods]] +parent = "TasksHandler" +name = "RunTaskAsync" +sig = "Task RunTaskAsync(Func task, JobSpecs? specs, Action pre, Action post, AsyncMode asyncMode)" +returns = "Task" +file = "Asyncx\\TasksHandler.cs" [[classes]] -name = "CachedImageStorageExtensions" -ns = "FEx.Legacy.Imaging.Extensions" -file = "Imaging\\Extensions\\CachedImageStorageExtensions.cs" +name = "MappedDriveResolver" +ns = "FEx.Legacy.IO" +summary = "A static class to help with resolving a mapped drive path to a UNC network path. If a local drive path or a UNC network path are passed in, they will just be returned." +file = "IO\\MappedDriveResolver.cs" static = true -[[extensions]] -name = "EntryCacheShouldBePrepared" -sig = "bool EntryCacheShouldBePrepared(this ICachedImageStorage storage, IIndexEntryBase entry)" -returns = "bool" -file = "Imaging\\Extensions\\CachedImageStorageExtensions.cs" +[[methods]] +parent = "MappedDriveResolver" +name = "ReadMappedDrives" +sig = "static Dictionary ReadMappedDrives()" +returns = "Dictionary" +file = "IO\\MappedDriveResolver.cs" +static = true -[[extensions]] -name = "GetEntryBaseAsync" -sig = "Task GetEntryBaseAsync(this ICachedImageStorage storage, Uri fileUrl)" -returns = "Task" -file = "Imaging\\Extensions\\CachedImageStorageExtensions.cs" +[[methods]] +parent = "MappedDriveResolver" +name = "ResolveToUnc" +sig = "static string ResolveToUnc(string path)" +returns = "string" +summary = "Resolves the given path to a full UNC path if the path is a mapped drive. Otherwise, just returns the given path." +file = "IO\\MappedDriveResolver.cs" +static = true -[[extensions]] -name = "PrepareCacheAndGetEntryBaseAsync" -sig = "Task PrepareCacheAndGetEntryBaseAsync(this ICachedImageStorage storage, Uri fileUrl)" -returns = "Task" -file = "Imaging\\Extensions\\CachedImageStorageExtensions.cs" +[[methods]] +parent = "MappedDriveResolver" +name = "CheckUncPath" +sig = "static string CheckUncPath(string mappedDrive)" +returns = "string" +summary = "Given a local mapped drive letter, determine if it is a network drive. If so, return the server share." +file = "IO\\MappedDriveResolver.cs" +static = true -[[extensions]] -name = "PrepareCacheEntryAsync" -sig = "Task PrepareCacheEntryAsync(this ICachedImageStorage storage, IIndexEntryBase entry)" -returns = "Task" -file = "Imaging\\Extensions\\CachedImageStorageExtensions.cs" +[[methods]] +parent = "MappedDriveResolver" +name = "ResolveToRootUnc" +sig = "static string ResolveToRootUnc(string path)" +returns = "string" +summary = "Resolves the given path to a root UNC path if the path is a mapped drive. Otherwise, just returns the given path." +file = "IO\\MappedDriveResolver.cs" +static = true -[[extensions]] -name = "CacheAllAsync" -sig = "Task CacheAllAsync(this ICachedImageStorage storage)" -returns = "Task" -file = "Imaging\\Extensions\\CachedImageStorageExtensions.cs" +[[methods]] +parent = "MappedDriveResolver" +name = "IsNetworkDrive" +sig = "static bool IsNetworkDrive(string path)" +returns = "bool" +summary = "Checks if the given path is a network drive." +file = "IO\\MappedDriveResolver.cs" +static = true -[[classes]] -name = "MappedDriveResolver" -ns = "FEx.Legacy.IO" +[[methods]] +parent = "MappedDriveResolver" +name = "GetDriveLetter" +sig = "static string GetDriveLetter(string path)" +returns = "string" +summary = "Given a path will extract just the drive letter with volume separator." file = "IO\\MappedDriveResolver.cs" static = true @@ -129,152 +139,769 @@ ns = "FEx.Legacy.IO" summary = "https://www.codeproject.com/Articles/22736/Securely-Delete-a-File-using-NET" file = "IO\\Wipe.cs" +[[properties]] +parent = "Wipe" +name = "Instance" +sig = "static Wipe Instance { get; }" +returns = "Wipe" +file = "IO\\Wipe.cs" +static = true + +[[methods]] +parent = "Wipe" +name = "WipeFile" +sig = "void WipeFile(string filename, int timesToWrite)" +returns = "void" +summary = "Deletes a file in a secure way by overwriting it with random garbage data n times." +file = "IO\\Wipe.cs" + [[classes]] name = "PassInfoEventArgs" ns = "FEx.Legacy.IO" base = "EventArgs" file = "IO\\Wipe.cs" +[[properties]] +parent = "PassInfoEventArgs" +name = "CurrentPass" +sig = "int CurrentPass { get; }" +returns = "int" +summary = "Get the current pass" +file = "IO\\Wipe.cs" + +[[properties]] +parent = "PassInfoEventArgs" +name = "TotalPasses" +sig = "int TotalPasses { get; }" +returns = "int" +summary = "Get the total number of passes to be run" +file = "IO\\Wipe.cs" + +[[ctors]] +parent = "PassInfoEventArgs" +sig = "PassInfoEventArgs(int currentPass, int totalPasses)" +file = "IO\\Wipe.cs" + [[classes]] name = "SectorInfoEventArgs" ns = "FEx.Legacy.IO" base = "EventArgs" -summary = "Get the total number of passes to be run" +file = "IO\\Wipe.cs" + +[[properties]] +parent = "SectorInfoEventArgs" +name = "CurrentSector" +sig = "int CurrentSector { get; }" +returns = "int" +summary = "Get the current sector" +file = "IO\\Wipe.cs" + +[[properties]] +parent = "SectorInfoEventArgs" +name = "TotalSectors" +sig = "int TotalSectors { get; }" +returns = "int" +summary = "Get the total number of sectors to be run" +file = "IO\\Wipe.cs" + +[[ctors]] +parent = "SectorInfoEventArgs" +sig = "SectorInfoEventArgs(int currentSector, int totalSectors)" file = "IO\\Wipe.cs" [[classes]] name = "WipeDoneEventArgs" ns = "FEx.Legacy.IO" base = "EventArgs" -summary = "Get the total number of sectors to be run" file = "IO\\Wipe.cs" [[classes]] name = "WipeErrorEventArgs" ns = "FEx.Legacy.IO" base = "EventArgs" -summary = "Get the total number of sectors to be run" +file = "IO\\Wipe.cs" + +[[properties]] +parent = "WipeErrorEventArgs" +name = "WipeError" +sig = "Exception WipeError { get; }" +returns = "Exception" +file = "IO\\Wipe.cs" + +[[ctors]] +parent = "WipeErrorEventArgs" +sig = "WipeErrorEventArgs(Exception error)" file = "IO\\Wipe.cs" [[classes]] -name = "ViewModelBaseExtensions" -ns = "FEx.Legacy.Mvvm.Abstractions.Extensions" -file = "Mvvm\\Abstractions\\Extensions\\ViewModelBaseExtensions.cs" +name = "WebServices" +ns = "FEx.Legacy.Web" +file = "Web\\WebServices.cs" static = true -[[interfaces]] -name = "IProgressListenerViewModel" -ns = "FEx.Legacy.Mvvm.Abstractions.Interfaces" -file = "Mvvm\\Abstractions\\Interfaces\\IProgressListenerViewModel.cs" +[[properties]] +parent = "WebServices" +name = "BaseRequestUrl" +sig = "static string BaseRequestUrl { get; set; }" +returns = "string" +file = "Web\\WebServices.cs" +static = true -[[interfaces]] -name = "IProgressStateGet" -ns = "FEx.Legacy.Mvvm.Abstractions.Interfaces" -file = "Mvvm\\Abstractions\\Interfaces\\IProgressStateGet.cs" +[[properties]] +parent = "WebServices" +name = "StatusCodes" +sig = "static Dictionary StatusCodes { get; set; }" +returns = "Dictionary" +file = "Web\\WebServices.cs" +static = true -[[interfaces]] -name = "IProgressSubscriber" -ns = "FEx.Legacy.Mvvm.Abstractions.Interfaces" -file = "Mvvm\\Abstractions\\Interfaces\\IProgressSubscriber.cs" +[[methods]] +parent = "WebServices" +name = "GetRequestResultAsync" +sig = "static Task GetRequestResultAsync(string requestUrl, ICredentials credentials = null, bool resultAsJson = true, List omitCodes = null, List cookies = null)" +returns = "Task" +summary = "Handles GET requests." +file = "Web\\WebServices.cs" +static = true -[[interfaces]] -name = "IRunAsync" -ns = "FEx.Legacy.Mvvm.Abstractions.Interfaces" -file = "Mvvm\\Abstractions\\Interfaces\\IRunAsync.cs" +[[methods]] +parent = "WebServices" +name = "GetHttpResponseAsync" +sig = "static Task GetHttpResponseAsync(Func> responseFunc)" +returns = "Task" +file = "Web\\WebServices.cs" +static = true -[[interfaces]] -name = "IRunAsyncView" -ns = "FEx.Legacy.Mvvm.Abstractions.Interfaces" -file = "Mvvm\\Abstractions\\Interfaces\\IRunAsyncView.cs" +[[methods]] +parent = "WebServices" +name = "ConvertXmlToJson" +sig = "static string ConvertXmlToJson(string responseBody)" +returns = "string" +summary = "Converts the XML to json." +file = "Web\\WebServices.cs" +static = true -[[interfaces]] -name = "IThreadingAwareViewModel" -ns = "FEx.Legacy.Mvvm.Abstractions.Interfaces" -file = "Mvvm\\Abstractions\\Interfaces\\IThreadingAwareViewModel.cs" +[[methods]] +parent = "WebServices" +name = "PrepareHttpClient" +sig = "static HttpClient PrepareHttpClient(string address, ICredentials credentials, bool resultAsJson, IEnumerable cookies = null)" +returns = "HttpClient" +summary = "Prepares the HTTP client." +file = "Web\\WebServices.cs" +static = true + +[[methods]] +parent = "WebServices" +name = "PostRequestResultAsync" +sig = "static Task PostRequestResultAsync(string requestUrl, string postContent, ICredentials credentials = null, List omitCodes = null, List cookies = null)" +returns = "Task" +summary = "Handles POST requests." +file = "Web\\WebServices.cs" +static = true + +[[methods]] +parent = "WebServices" +name = "HandleResponseAsync" +sig = "static Task HandleResponseAsync(string requestUrl, List omitCodes, Func> responseHandler)" +returns = "Task" +summary = "Handles the response." +file = "Web\\WebServices.cs" +static = true + +[[methods]] +parent = "WebServices" +name = "GetWebApiResponseCodeInfo" +sig = "static string GetWebApiResponseCodeInfo(HttpStatusCode statusCode)" +returns = "string" +summary = "Translates to API status message." +file = "Web\\WebServices.cs" +static = true + +[[methods]] +parent = "WebServices" +name = "GetWebApiResponseCodeInfo" +sig = "static string GetWebApiResponseCodeInfo(int statusCode)" +returns = "string" +summary = "Translates to API status message." +file = "Web\\WebServices.cs" +static = true + +[[enums]] +name = "JobSpecs" +ns = "FEx.Legacy.Asyncx.Enums" +file = "Asyncx\\Enums\\JobSpecs.cs" [[classes]] -name = "RunAsyncExtensions" -ns = "FEx.Legacy.Mvvm.Extensions" -file = "Mvvm\\Extensions\\RunAsyncExtensions.cs" +name = "JobSpecsExtensions" +ns = "FEx.Legacy.Asyncx.Enums" +file = "Asyncx\\Enums\\JobSpecs.cs" static = true [[extensions]] -name = "RunAsync" -sig = "Task RunAsync(this IRunAsync runner, Action action)" -returns = "Task" -file = "Mvvm\\Extensions\\RunAsyncExtensions.cs" +name = "HasFlagsFast" +returns = "bool" +sig = "bool HasFlagsFast(this JobSpecs? value, params JobSpecs[] flags)" +file = "Asyncx\\Enums\\JobSpecs.cs" [[extensions]] -name = "RunTaskAsync" -sig = "Task RunTaskAsync(this IRunAsync runner, Func function)" -returns = "Task" -file = "Mvvm\\Extensions\\RunAsyncExtensions.cs" +name = "HasFlagFast" +returns = "bool" +sig = "bool HasFlagFast(this JobSpecs? value, JobSpecs flag)" +file = "Asyncx\\Enums\\JobSpecs.cs" [[classes]] -name = "RunAsyncViewExtensions" -ns = "FEx.Legacy.Mvvm.Extensions" -file = "Mvvm\\Extensions\\RunAsyncViewExtensions.cs" +name = "TasksHandlerExtensions" +ns = "FEx.Legacy.Asyncx.Extensions" +file = "Asyncx\\Extensions\\TasksHandlerExtensions.cs" static = true [[extensions]] name = "RunAsync" -sig = "Task RunAsync(this IRunAsyncView runner, Action action)" returns = "Task" -file = "Mvvm\\Extensions\\RunAsyncViewExtensions.cs" +sig = "Task RunAsync(this ITasksHandler handler, Action task)" +file = "Asyncx\\Extensions\\TasksHandlerExtensions.cs" + +[[extensions]] +name = "RunTaskAsync" +returns = "Task" +sig = "Task RunTaskAsync(this ITasksHandler handler, Func> task)" +file = "Asyncx\\Extensions\\TasksHandlerExtensions.cs" [[extensions]] name = "RunTaskAsync" -sig = "Task RunTaskAsync(this IRunAsyncView runner, Func function)" returns = "Task" -file = "Mvvm\\Extensions\\RunAsyncViewExtensions.cs" +sig = "Task RunTaskAsync(this ITasksHandler handler, Func task)" +file = "Asyncx\\Extensions\\TasksHandlerExtensions.cs" + +[[extensions]] +name = "RunFuncAsync" +returns = "Task" +sig = "Task RunFuncAsync(this ITasksHandler handler, Func task)" +file = "Asyncx\\Extensions\\TasksHandlerExtensions.cs" [[classes]] -name = "ThreadingAwareViewModelExtensions" -ns = "FEx.Legacy.Mvvm.Extensions" -file = "Mvvm\\Extensions\\ThreadingAwareViewModelExtensions.cs" +name = "CachedImageStorageExtensions" +ns = "FEx.Legacy.Imaging.Extensions" +file = "Imaging\\Extensions\\CachedImageStorageExtensions.cs" static = true [[extensions]] -name = "PostMainJob" -sig = "void PostMainJob(this IThreadingAwareViewModel viewModel)" -returns = "void" -file = "Mvvm\\Extensions\\ThreadingAwareViewModelExtensions.cs" - -[[classes]] -name = "DelayedNotificationObserver" -ns = "FEx.Legacy.Mvvm.Observables" -base = "IDisposable" -file = "Mvvm\\Observables\\DelayedNotificationObserver.cs" +name = "EntryCacheShouldBePrepared" +returns = "bool" +sig = "bool EntryCacheShouldBePrepared(this ICachedImageStorage storage, IIndexEntryBase entry)" +file = "Imaging\\Extensions\\CachedImageStorageExtensions.cs" -[[classes]] +[[extensions]] +name = "GetEntryBaseAsync" +returns = "Task" +sig = "Task GetEntryBaseAsync(this ICachedImageStorage storage, Uri fileUrl)" +file = "Imaging\\Extensions\\CachedImageStorageExtensions.cs" + +[[extensions]] +name = "PrepareCacheAndGetEntryBaseAsync" +returns = "Task" +sig = "Task PrepareCacheAndGetEntryBaseAsync(this ICachedImageStorage storage, Uri fileUrl)" +file = "Imaging\\Extensions\\CachedImageStorageExtensions.cs" + +[[extensions]] +name = "PrepareCacheEntryAsync" +returns = "Task" +sig = "Task PrepareCacheEntryAsync(this ICachedImageStorage storage, IIndexEntryBase entry)" +file = "Imaging\\Extensions\\CachedImageStorageExtensions.cs" + +[[extensions]] +name = "CacheAllAsync" +returns = "Task" +sig = "Task CacheAllAsync(this ICachedImageStorage storage)" +file = "Imaging\\Extensions\\CachedImageStorageExtensions.cs" + +[[classes]] +name = "RunAsyncExtensions" +ns = "FEx.Legacy.Mvvm.Extensions" +file = "Mvvm\\Extensions\\RunAsyncExtensions.cs" +static = true + +[[extensions]] +name = "RunAsync" +returns = "Task" +sig = "Task RunAsync(this IRunAsync runner, Action action)" +file = "Mvvm\\Extensions\\RunAsyncExtensions.cs" + +[[extensions]] +name = "RunFuncAsync" +returns = "Task" +sig = "Task RunFuncAsync(this IRunAsync runner, Func function)" +file = "Mvvm\\Extensions\\RunAsyncExtensions.cs" + +[[extensions]] +name = "RunTaskAsync" +returns = "Task" +sig = "Task RunTaskAsync(this IRunAsync runner, Func function)" +file = "Mvvm\\Extensions\\RunAsyncExtensions.cs" + +[[extensions]] +name = "RunTaskAsync" +returns = "Task" +sig = "Task RunTaskAsync(this IRunAsync runner, Func> function)" +file = "Mvvm\\Extensions\\RunAsyncExtensions.cs" + +[[classes]] +name = "RunAsyncViewExtensions" +ns = "FEx.Legacy.Mvvm.Extensions" +file = "Mvvm\\Extensions\\RunAsyncViewExtensions.cs" +static = true + +[[extensions]] +name = "RunAsync" +returns = "Task" +sig = "Task RunAsync(this IRunAsyncView runner, Action action)" +file = "Mvvm\\Extensions\\RunAsyncViewExtensions.cs" + +[[extensions]] +name = "RunFuncAsync" +returns = "Task" +sig = "Task RunFuncAsync(this IRunAsyncView runner, Func function)" +file = "Mvvm\\Extensions\\RunAsyncViewExtensions.cs" + +[[extensions]] +name = "RunTaskAsync" +returns = "Task" +sig = "Task RunTaskAsync(this IRunAsyncView runner, Func function)" +file = "Mvvm\\Extensions\\RunAsyncViewExtensions.cs" + +[[extensions]] +name = "RunTaskAsync" +returns = "Task" +sig = "Task RunTaskAsync(this IRunAsyncView runner, Func> function)" +file = "Mvvm\\Extensions\\RunAsyncViewExtensions.cs" + +[[classes]] +name = "ThreadingAwareViewModelExtensions" +ns = "FEx.Legacy.Mvvm.Extensions" +file = "Mvvm\\Extensions\\ThreadingAwareViewModelExtensions.cs" +static = true + +[[extensions]] +name = "PostMainJob" +returns = "void" +sig = "void PostMainJob(this IThreadingAwareViewModel viewModel)" +file = "Mvvm\\Extensions\\ThreadingAwareViewModelExtensions.cs" + +[[classes]] +name = "DelayedNotificationObserver" +ns = "FEx.Legacy.Mvvm.Observables" +base = "IDisposable" +file = "Mvvm\\Observables\\DelayedNotificationObserver.cs" + +[[properties]] +parent = "DelayedNotificationObserver" +name = "StateChange" +sig = "IDisposable StateChange { get; }" +returns = "IDisposable" +file = "Mvvm\\Observables\\DelayedNotificationObserver.cs" + +[[properties]] +parent = "DelayedNotificationObserver" +name = "Get" +sig = "Func Get { get; }" +returns = "Func" +file = "Mvvm\\Observables\\DelayedNotificationObserver.cs" + +[[properties]] +parent = "DelayedNotificationObserver" +name = "Set" +sig = "Action Set { get; }" +returns = "Action" +file = "Mvvm\\Observables\\DelayedNotificationObserver.cs" + +[[ctors]] +parent = "DelayedNotificationObserver" +sig = "DelayedNotificationObserver(Func getFunc, Action setFunc)" +file = "Mvvm\\Observables\\DelayedNotificationObserver.cs" + +[[ctors]] +parent = "DelayedNotificationObserver" +sig = "DelayedNotificationObserver(Func getFunc, Action setFunc, TimeSpan delayTimeSpan)" +file = "Mvvm\\Observables\\DelayedNotificationObserver.cs" + +[[methods]] +parent = "DelayedNotificationObserver" +name = "Report" +sig = "void Report(T value)" +returns = "void" +file = "Mvvm\\Observables\\DelayedNotificationObserver.cs" + +[[methods]] +parent = "DelayedNotificationObserver" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Mvvm\\Observables\\DelayedNotificationObserver.cs" + +[[methods]] +parent = "DelayedNotificationObserver" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +file = "Mvvm\\Observables\\DelayedNotificationObserver.cs" + +[[classes]] name = "ProducerConsumerCollectionBase" ns = "FEx.Legacy.Mvvm.Observables" base = "IProducerConsumerCollection" summary = "Provides a base implementation for producer-consumer collections that wrap other producer-consumer collections. Based on https://github.com/ChadBurggraf/parallel-extensions-extras" file = "Mvvm\\Observables\\ProducerConsumerCollectionBase.cs" +[[properties]] +parent = "ProducerConsumerCollectionBase" +name = "Count" +sig = "int Count { get; }" +returns = "int" +summary = "Gets the number of elements contained in the collection." +file = "Mvvm\\Observables\\ProducerConsumerCollectionBase.cs" + +[[properties]] +parent = "ProducerConsumerCollectionBase" +name = "ContainedCollection" +sig = "IProducerConsumerCollection ContainedCollection { get; }" +returns = "IProducerConsumerCollection" +summary = "Gets the contained collection." +file = "Mvvm\\Observables\\ProducerConsumerCollectionBase.cs" + +[[ctors]] +parent = "ProducerConsumerCollectionBase" +sig = "ProducerConsumerCollectionBase(IProducerConsumerCollection contained)" +summary = "Initializes the ProducerConsumerCollectionBase instance." +file = "Mvvm\\Observables\\ProducerConsumerCollectionBase.cs" + +[[methods]] +parent = "ProducerConsumerCollectionBase" +name = "GetEnumerator" +sig = "IEnumerator GetEnumerator()" +returns = "IEnumerator" +summary = "Gets an enumerator for the collection." +file = "Mvvm\\Observables\\ProducerConsumerCollectionBase.cs" + +[[methods]] +parent = "ProducerConsumerCollectionBase" +name = "ToArray" +sig = "T[] ToArray()" +returns = "T[]" +summary = "Creates an array containing the contents of the collection." +file = "Mvvm\\Observables\\ProducerConsumerCollectionBase.cs" + +[[methods]] +parent = "ProducerConsumerCollectionBase" +name = "CopyTo" +sig = "void CopyTo(T[] array, int index)" +returns = "void" +summary = "Copies the contents of the collection to an array." +file = "Mvvm\\Observables\\ProducerConsumerCollectionBase.cs" + +[[methods]] +parent = "ProducerConsumerCollectionBase" +name = "TryAdd" +sig = "bool TryAdd(T item)" +returns = "bool" +summary = "Attempts to add the specified value to the end of the deque." +file = "Mvvm\\Observables\\ProducerConsumerCollectionBase.cs" + +[[methods]] +parent = "ProducerConsumerCollectionBase" +name = "TryTake" +sig = "bool TryTake(out T item)" +returns = "bool" +summary = "Attempts to remove and return an item from the collection." +file = "Mvvm\\Observables\\ProducerConsumerCollectionBase.cs" + [[classes]] name = "ProducerConsumerCollectionDebugView" ns = "FEx.Legacy.Mvvm.Observables" summary = "Debug view for the IProducerConsumerCollection. Based on https://github.com/ChadBurggraf/parallel-extensions-extras" file = "Mvvm\\Observables\\ProducerConsumerCollectionDebugView.cs" +[[properties]] +parent = "ProducerConsumerCollectionDebugView" +name = "Values" +sig = "T[] Values { get; }" +returns = "T[]" +file = "Mvvm\\Observables\\ProducerConsumerCollectionDebugView.cs" + +[[ctors]] +parent = "ProducerConsumerCollectionDebugView" +sig = "ProducerConsumerCollectionDebugView(IProducerConsumerCollection collection)" +file = "Mvvm\\Observables\\ProducerConsumerCollectionDebugView.cs" + [[classes]] name = "SubscriptionActions" ns = "FEx.Legacy.Mvvm.Observables" file = "Mvvm\\Observables\\SubscriptionActions.cs" +[[properties]] +parent = "SubscriptionActions" +name = "OnNext" +sig = "Action OnNext { get; }" +returns = "Action" +file = "Mvvm\\Observables\\SubscriptionActions.cs" + +[[properties]] +parent = "SubscriptionActions" +name = "OnError" +sig = "Action OnError { get; }" +returns = "Action" +file = "Mvvm\\Observables\\SubscriptionActions.cs" + +[[properties]] +parent = "SubscriptionActions" +name = "OnCompleted" +sig = "Action OnCompleted { get; }" +returns = "Action" +file = "Mvvm\\Observables\\SubscriptionActions.cs" + +[[ctors]] +parent = "SubscriptionActions" +sig = "SubscriptionActions(Action onNext)" +file = "Mvvm\\Observables\\SubscriptionActions.cs" + +[[ctors]] +parent = "SubscriptionActions" +sig = "SubscriptionActions(Action onNext, Action onError, Action onCompleted)" +file = "Mvvm\\Observables\\SubscriptionActions.cs" + +[[methods]] +parent = "SubscriptionActions" +name = "GetSubscription" +sig = "IDisposable GetSubscription(IObservable observable)" +returns = "IDisposable" +file = "Mvvm\\Observables\\SubscriptionActions.cs" + +[[methods]] +parent = "SubscriptionActions" +name = "GetSubscription" +sig = "IDisposable GetSubscription(IObservable observable, T subscriptionArgument)" +returns = "IDisposable" +file = "Mvvm\\Observables\\SubscriptionActions.cs" + [[classes]] name = "ProgressAggregatorViewModel" ns = "FEx.Legacy.Mvvm.ViewModels" base = "ProgressListenerViewModel" file = "Mvvm\\ViewModels\\ProgressAggregatorViewModel.cs" +[[ctors]] +parent = "ProgressAggregatorViewModel" +sig = "ProgressAggregatorViewModel(params IAsyncInitializable[] dependencies)" +file = "Mvvm\\ViewModels\\ProgressAggregatorViewModel.cs" + +[[ctors]] +parent = "ProgressAggregatorViewModel" +sig = "ProgressAggregatorViewModel(bool useMainProgressContainer, params IAsyncInitializable[] dependencies)" +file = "Mvvm\\ViewModels\\ProgressAggregatorViewModel.cs" + [[classes]] name = "ProgressListenerViewModel" ns = "FEx.Legacy.Mvvm.ViewModels" -base = "ThreadingAwareViewModel, IProgressListenerViewModel - where T : class, IProgressAggregator, new()" +base = "ThreadingAwareViewModel, IProgressListenerViewModel" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[properties]] +parent = "ProgressListenerViewModel" +name = "Subscriptions" +sig = "ConcurrentDictionary Subscriptions { get; }" +returns = "ConcurrentDictionary" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[properties]] +parent = "ProgressListenerViewModel" +name = "Progress" +sig = "T Progress { get; }" +returns = "T" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[properties]] +parent = "ProgressListenerViewModel" +name = "Application" +sig = "IAppInfoProvider Application { get; }" +returns = "IAppInfoProvider" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[properties]] +parent = "ProgressListenerViewModel" +name = "ProgressSrv" +sig = "static ProgressService ProgressSrv { get; }" +returns = "ProgressService" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" +static = true + +[[properties]] +parent = "ProgressListenerViewModel" +name = "Watch" +sig = "Stopwatch Watch { get; }" +returns = "Stopwatch" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[properties]] +parent = "ProgressListenerViewModel" +name = "Timer" +sig = "IFExTimer Timer { get; }" +returns = "IFExTimer" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[properties]] +parent = "ProgressListenerViewModel" +name = "Stopwatch" +sig = "Stopwatch Stopwatch { get; }" +returns = "Stopwatch" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[ctors]] +parent = "ProgressListenerViewModel" +sig = "ProgressListenerViewModel(params IAsyncInitializable[] dependencies)" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[ctors]] +parent = "ProgressListenerViewModel" +sig = "ProgressListenerViewModel(bool useMainProgressContainer, params IAsyncInitializable[] dependencies)" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "SubscribeToProgress" +sig = "bool SubscribeToProgress(IProgressReceiver progressReceiver, params string[] iProgressReceiverProperties) where TCon : IProgressAggregator" +returns = "bool" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "SubscribeToProgress" +sig = "bool SubscribeToProgress(string containerId, params string[] iProgressReceiverProperties)" +returns = "bool" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "SubscribeToProgress" +sig = "bool SubscribeToProgress(IProgressAggregator container, params string[] iProgressReceiverProperties)" +returns = "bool" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "UnsubscribeFromProgress" +sig = "bool UnsubscribeFromProgress(IProgressReceiver progressReceiver) where TCon : IProgressAggregator" +returns = "bool" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "UnsubscribeFromProgress" +sig = "bool UnsubscribeFromProgress(string containerId)" +returns = "bool" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "UnsubscribeFromProgress" +sig = "bool UnsubscribeFromProgress(IProgressAggregator container)" +returns = "bool" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "PostMainJob" +sig = "void PostMainJob(bool showTimeInfo)" +returns = "void" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "PreMainJob" +sig = "void PreMainJob()" +returns = "void" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "PrgSet" +sig = "void PrgSet(ProgressSnapshot snapshot)" +returns = "void" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "PrgSet" +sig = "void PrgSet(double? val)" +returns = "void" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "PrgSet" +sig = "void PrgSet(double? val, double? max, ProgressChangeMode mode)" +returns = "void" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "Busy" +sig = "void Busy()" +returns = "void" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "Idle" +sig = "void Idle()" +returns = "void" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "PrgSetEnd" +sig = "void PrgSetEnd()" +returns = "void" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "PrgSetMax" +sig = "void PrgSetMax(double max)" +returns = "void" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "PrgAdd" +sig = "void PrgAdd()" +returns = "void" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "PrgAdd" +sig = "void PrgAdd(double val)" +returns = "void" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "PrgMaxAdd" +sig = "void PrgMaxAdd(double addedValue)" +returns = "void" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "SubscribeToProgressExcept" +sig = "void SubscribeToProgressExcept(TProgress producer, params string[] iProgressReceiverProperties) where TProgress : IProgressAggregator" +returns = "void" +file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" + +[[methods]] +parent = "ProgressListenerViewModel" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" file = "Mvvm\\ViewModels\\ProgressListenerViewModel.cs" [[classes]] @@ -282,15 +909,526 @@ name = "ThreadingAwareViewModel" ns = "FEx.Legacy.Mvvm.ViewModels" file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" +[[properties]] +parent = "ThreadingAwareViewModel" +name = "IsInitialized" +sig = "bool IsInitialized { get; set; }" +returns = "bool" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" + +[[properties]] +parent = "ThreadingAwareViewModel" +name = "HasFinishedInitialization" +sig = "bool HasFinishedInitialization { get; }" +returns = "bool" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" + +[[properties]] +parent = "ThreadingAwareViewModel" +name = "IsInitializing" +sig = "bool IsInitializing { get; }" +returns = "bool" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" + +[[properties]] +parent = "ThreadingAwareViewModel" +name = "TypeName" +sig = "string TypeName { get; set; }" +returns = "string" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" + +[[properties]] +parent = "ThreadingAwareViewModel" +name = "TypeFullName" +sig = "string TypeFullName { get; set; }" +returns = "string" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" + +[[properties]] +parent = "ThreadingAwareViewModel" +name = "SkipDependenciesInitialization" +sig = "bool SkipDependenciesInitialization { get; set; }" +returns = "bool" +summary = "If true doesn't wait for dependencies initialization" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" + +[[methods]] +parent = "ThreadingAwareViewModel" +name = "InitializeAsync" +sig = "Task InitializeAsync()" +returns = "Task" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" + +[[methods]] +parent = "ThreadingAwareViewModel" +name = "Reset" +sig = "void Reset()" +returns = "void" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" + +[[methods]] +parent = "ThreadingAwareViewModel" +name = "BeginInitialization" +sig = "void BeginInitialization(bool waitSynchronouslyForInitialization)" +returns = "void" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" + +[[methods]] +parent = "ThreadingAwareViewModel" +name = "BeginInitialization" +sig = "void BeginInitialization()" +returns = "void" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" + +[[methods]] +parent = "ThreadingAwareViewModel" +name = "SafeInitializeAsync" +sig = "static Task> SafeInitializeAsync(IAsyncInitializable dependency)" +returns = "Task>" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" +static = true + +[[methods]] +parent = "ThreadingAwareViewModel" +name = "OnInitializeAsync" +sig = "Task OnInitializeAsync()" +returns = "Task" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" + +[[methods]] +parent = "ThreadingAwareViewModel" +name = "InitializeDependenciesAsync" +sig = "Task InitializeDependenciesAsync()" +returns = "Task" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" + +[[methods]] +parent = "ThreadingAwareViewModel" +name = "InitializeCoreAsync" +sig = "Task InitializeCoreAsync()" +returns = "Task" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" + +[[methods]] +parent = "ThreadingAwareViewModel" +name = "ThrowIfNotInitialized" +sig = "void ThrowIfNotInitialized()" +returns = "void" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" + +[[methods]] +parent = "ThreadingAwareViewModel" +name = "AddDependency" +sig = "void AddDependency(IAsyncInitializable dependency)" +returns = "void" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" + +[[methods]] +parent = "ThreadingAwareViewModel" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" + +[[methods]] +parent = "ThreadingAwareViewModel" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.AsyncInitializable.cs" + [[classes]] name = "ThreadingAwareViewModel" ns = "FEx.Legacy.Mvvm.ViewModels" base = "ViewModelBase, IThreadingAwareViewModel" file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.cs" +[[properties]] +parent = "ThreadingAwareViewModel" +name = "IsUiUnlocked" +sig = "bool IsUiUnlocked { get; set; }" +returns = "bool" +summary = "Gets or sets a value indicating whether View instance related with this ViewModel is unlocked." +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.cs" + +[[properties]] +parent = "ThreadingAwareViewModel" +name = "OriginSynchronizationContext" +sig = "SynchronizationContext OriginSynchronizationContext { get; }" +returns = "SynchronizationContext" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.cs" + +[[properties]] +parent = "ThreadingAwareViewModel" +name = "Dispatcher" +sig = "IFExDispatcher Dispatcher { get; }" +returns = "IFExDispatcher" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.cs" + +[[ctors]] +parent = "ThreadingAwareViewModel" +sig = "ThreadingAwareViewModel(params IAsyncInitializable[] dependencies)" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.cs" + +[[methods]] +parent = "ThreadingAwareViewModel" +name = "RunAsync" +sig = "Task RunAsync(Action action, JobSpecs? specs, Action pre, Action post)" +returns = "Task" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.cs" + +[[methods]] +parent = "ThreadingAwareViewModel" +name = "RunTaskAsync" +sig = "Task RunTaskAsync(Func function, JobSpecs? specs, Action pre, Action post)" +returns = "Task" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.cs" + +[[methods]] +parent = "ThreadingAwareViewModel" +name = "RunTaskAsync" +sig = "Task RunTaskAsync(Func> function, JobSpecs? specs, Action pre, Action post)" +returns = "Task" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.cs" + +[[methods]] +parent = "ThreadingAwareViewModel" +name = "RunFuncAsync" +sig = "Task RunFuncAsync(Func function, JobSpecs? specs, Action pre, Action post)" +returns = "Task" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.cs" + +[[methods]] +parent = "ThreadingAwareViewModel" +name = "PostMainJob" +sig = "void PostMainJob(bool showTimeInfo)" +returns = "void" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.cs" + +[[methods]] +parent = "ThreadingAwareViewModel" +name = "PreMainJob" +sig = "void PreMainJob()" +returns = "void" +file = "Mvvm\\ViewModels\\ThreadingAwareViewModel.cs" + +[[interfaces]] +name = "ITasksHandler" +ns = "FEx.Legacy.Asyncx.Abstractions.Interfaces" +file = "Asyncx\\Abstractions\\Interfaces\\ITasksHandler.cs" + +[[methods]] +parent = "ITasksHandler" +name = "RunAsync" +sig = "Task RunAsync(Action task, JobSpecs? specs, Action pre, Action post, AsyncMode asyncMode, CancellationToken cancellationToken)" +returns = "Task" +file = "Asyncx\\Abstractions\\Interfaces\\ITasksHandler.cs" + +[[methods]] +parent = "ITasksHandler" +name = "RunTaskAsync" +sig = "Task RunTaskAsync(Func> task, JobSpecs? specs, Action pre, Action post, AsyncMode asyncMode)" +returns = "Task" +file = "Asyncx\\Abstractions\\Interfaces\\ITasksHandler.cs" + +[[methods]] +parent = "ITasksHandler" +name = "RunTaskAsync" +sig = "Task RunTaskAsync(Func task, JobSpecs? specs, Action pre, Action post, AsyncMode asyncMode)" +returns = "Task" +file = "Asyncx\\Abstractions\\Interfaces\\ITasksHandler.cs" + +[[methods]] +parent = "ITasksHandler" +name = "RunFuncAsync" +sig = "Task RunFuncAsync(Func task, JobSpecs? specs, Action pre, Action post, AsyncMode asyncMode, CancellationToken cancellationToken)" +returns = "Task" +file = "Asyncx\\Abstractions\\Interfaces\\ITasksHandler.cs" + +[[interfaces]] +name = "ICachedImageStorage" +ns = "FEx.Legacy.Imaging.Abstractions.Interfaces" +file = "Imaging\\Abstractions\\Interfaces\\ICachedImageStorage.cs" + +[[methods]] +parent = "ICachedImageStorage" +name = "EntryCacheShouldBePrepared" +sig = "bool EntryCacheShouldBePrepared(IIndexEntryBase entry, bool refresh)" +returns = "bool" +file = "Imaging\\Abstractions\\Interfaces\\ICachedImageStorage.cs" + +[[methods]] +parent = "ICachedImageStorage" +name = "GetEntryBaseAsync" +sig = "Task GetEntryBaseAsync(Uri fileUrl, bool addNew, string fileName)" +returns = "Task" +file = "Imaging\\Abstractions\\Interfaces\\ICachedImageStorage.cs" + +[[methods]] +parent = "ICachedImageStorage" +name = "PrepareCacheAndGetEntryBaseAsync" +sig = "Task PrepareCacheAndGetEntryBaseAsync(Uri fileUrl, WebRequestParams pars, bool refresh)" +returns = "Task" +file = "Imaging\\Abstractions\\Interfaces\\ICachedImageStorage.cs" + +[[methods]] +parent = "ICachedImageStorage" +name = "PrepareCacheEntryAsync" +sig = "Task PrepareCacheEntryAsync(IIndexEntryBase entry, WebRequestParams pars, bool refresh, HttpWebResponse response, string checksum, Func urlModifier)" +returns = "Task" +file = "Imaging\\Abstractions\\Interfaces\\ICachedImageStorage.cs" + +[[methods]] +parent = "ICachedImageStorage" +name = "GetFileSize" +sig = "long GetFileSize(Uri imageLink)" +returns = "long" +file = "Imaging\\Abstractions\\Interfaces\\ICachedImageStorage.cs" + +[[methods]] +parent = "ICachedImageStorage" +name = "GetFileName" +sig = "string GetFileName(Uri imageLink)" +returns = "string" +file = "Imaging\\Abstractions\\Interfaces\\ICachedImageStorage.cs" + +[[methods]] +parent = "ICachedImageStorage" +name = "CacheAllAsync" +sig = "Task CacheAllAsync(HashSet keys)" +returns = "Task" +file = "Imaging\\Abstractions\\Interfaces\\ICachedImageStorage.cs" + +[[methods]] +parent = "ICachedImageStorage" +name = "ContainsEntryAsync" +sig = "Task ContainsEntryAsync(Uri fileUrl)" +returns = "Task" +file = "Imaging\\Abstractions\\Interfaces\\ICachedImageStorage.cs" + +[[methods]] +parent = "ICachedImageStorage" +name = "GetFileChecksum" +sig = "string GetFileChecksum(Uri imageLink)" +returns = "string" +file = "Imaging\\Abstractions\\Interfaces\\ICachedImageStorage.cs" + +[[methods]] +parent = "ICachedImageStorage" +name = "RemoveIndexEntriesAsync" +sig = "Task RemoveIndexEntriesAsync(params string[] ids)" +returns = "Task" +file = "Imaging\\Abstractions\\Interfaces\\ICachedImageStorage.cs" + +[[interfaces]] +name = "IIndexEntryBase" +ns = "FEx.Legacy.Imaging.Abstractions.Interfaces" +base = "IEquatable" +file = "Imaging\\Abstractions\\Interfaces\\IIndexEntryBase.cs" + +[[properties]] +parent = "IIndexEntryBase" +name = "AbsoluteUri" +sig = "string AbsoluteUri { get; set; }" +returns = "string" +file = "Imaging\\Abstractions\\Interfaces\\IIndexEntryBase.cs" + +[[properties]] +parent = "IIndexEntryBase" +name = "CheckSum" +sig = "string CheckSum { get; set; }" +returns = "string" +file = "Imaging\\Abstractions\\Interfaces\\IIndexEntryBase.cs" + +[[properties]] +parent = "IIndexEntryBase" +name = "FilePath" +sig = "string FilePath { get; set; }" +returns = "string" +file = "Imaging\\Abstractions\\Interfaces\\IIndexEntryBase.cs" + +[[properties]] +parent = "IIndexEntryBase" +name = "ResponseContentLength" +sig = "long ResponseContentLength { get; set; }" +returns = "long" +file = "Imaging\\Abstractions\\Interfaces\\IIndexEntryBase.cs" + +[[properties]] +parent = "IIndexEntryBase" +name = "PixelHeight" +sig = "int PixelHeight { get; set; }" +returns = "int" +file = "Imaging\\Abstractions\\Interfaces\\IIndexEntryBase.cs" + +[[properties]] +parent = "IIndexEntryBase" +name = "PixelWidth" +sig = "int PixelWidth { get; set; }" +returns = "int" +file = "Imaging\\Abstractions\\Interfaces\\IIndexEntryBase.cs" + +[[properties]] +parent = "IIndexEntryBase" +name = "LocalUri" +sig = "Uri LocalUri { get; }" +returns = "Uri" +file = "Imaging\\Abstractions\\Interfaces\\IIndexEntryBase.cs" + +[[methods]] +parent = "IIndexEntryBase" +name = "IsEqual" +sig = "bool IsEqual(IIndexEntryBase val)" +returns = "bool" +file = "Imaging\\Abstractions\\Interfaces\\IIndexEntryBase.cs" + [[classes]] -name = "WebServices" -ns = "FEx.Legacy.Web" -file = "Web\\WebServices.cs" +name = "ViewModelBaseExtensions" +ns = "FEx.Legacy.Mvvm.Abstractions.Extensions" +file = "Mvvm\\Abstractions\\Extensions\\ViewModelBaseExtensions.cs" static = true +[[extensions]] +name = "GetListenerKey" +returns = "string" +sig = "string GetListenerKey(this IViewModelBase sender, TRec receiver, string propertyName)" +file = "Mvvm\\Abstractions\\Extensions\\ViewModelBaseExtensions.cs" + +[[interfaces]] +name = "IProgressListenerViewModel" +ns = "FEx.Legacy.Mvvm.Abstractions.Interfaces" +base = "IProgressReceiver, IThreadingAwareViewModel" +file = "Mvvm\\Abstractions\\Interfaces\\IProgressListenerViewModel.cs" + +[[interfaces]] +name = "IProgressStateGet" +ns = "FEx.Legacy.Mvvm.Abstractions.Interfaces" +file = "Mvvm\\Abstractions\\Interfaces\\IProgressStateGet.cs" + +[[properties]] +parent = "IProgressStateGet" +name = "IsFileOperation" +sig = "bool IsFileOperation { get; }" +returns = "bool" +file = "Mvvm\\Abstractions\\Interfaces\\IProgressStateGet.cs" + +[[properties]] +parent = "IProgressStateGet" +name = "IsPrgInfoVisible" +sig = "bool? IsPrgInfoVisible { get; }" +returns = "bool?" +file = "Mvvm\\Abstractions\\Interfaces\\IProgressStateGet.cs" + +[[properties]] +parent = "IProgressStateGet" +name = "IsBusy" +sig = "bool IsBusy { get; }" +returns = "bool" +file = "Mvvm\\Abstractions\\Interfaces\\IProgressStateGet.cs" + +[[interfaces]] +name = "IProgressSubscriber" +ns = "FEx.Legacy.Mvvm.Abstractions.Interfaces" +file = "Mvvm\\Abstractions\\Interfaces\\IProgressSubscriber.cs" + +[[methods]] +parent = "IProgressSubscriber" +name = "Report" +sig = "void Report(string propertyName, object value)" +returns = "void" +file = "Mvvm\\Abstractions\\Interfaces\\IProgressSubscriber.cs" + +[[interfaces]] +name = "IRunAsync" +ns = "FEx.Legacy.Mvvm.Abstractions.Interfaces" +file = "Mvvm\\Abstractions\\Interfaces\\IRunAsync.cs" + +[[methods]] +parent = "IRunAsync" +name = "RunAsync" +sig = "Task RunAsync(Action action, JobSpecs? specs, Action pre, Action post)" +returns = "Task" +file = "Mvvm\\Abstractions\\Interfaces\\IRunAsync.cs" + +[[methods]] +parent = "IRunAsync" +name = "RunFuncAsync" +sig = "Task RunFuncAsync(Func function, JobSpecs? specs, Action pre, Action post)" +returns = "Task" +file = "Mvvm\\Abstractions\\Interfaces\\IRunAsync.cs" + +[[methods]] +parent = "IRunAsync" +name = "RunTaskAsync" +sig = "Task RunTaskAsync(Func function, JobSpecs? specs, Action pre, Action post)" +returns = "Task" +file = "Mvvm\\Abstractions\\Interfaces\\IRunAsync.cs" + +[[methods]] +parent = "IRunAsync" +name = "RunTaskAsync" +sig = "Task RunTaskAsync(Func> function, JobSpecs? specs, Action pre, Action post)" +returns = "Task" +file = "Mvvm\\Abstractions\\Interfaces\\IRunAsync.cs" + +[[interfaces]] +name = "IRunAsyncView" +ns = "FEx.Legacy.Mvvm.Abstractions.Interfaces" +file = "Mvvm\\Abstractions\\Interfaces\\IRunAsyncView.cs" + +[[methods]] +parent = "IRunAsyncView" +name = "RunAsync" +sig = "Task RunAsync(Action action, object sender, JobSpecs? specs)" +returns = "Task" +file = "Mvvm\\Abstractions\\Interfaces\\IRunAsyncView.cs" + +[[methods]] +parent = "IRunAsyncView" +name = "RunFuncAsync" +sig = "Task RunFuncAsync(Func function, object sender, JobSpecs? specs)" +returns = "Task" +file = "Mvvm\\Abstractions\\Interfaces\\IRunAsyncView.cs" + +[[methods]] +parent = "IRunAsyncView" +name = "RunTaskAsync" +sig = "Task RunTaskAsync(Func function, object sender, JobSpecs? specs)" +returns = "Task" +file = "Mvvm\\Abstractions\\Interfaces\\IRunAsyncView.cs" + +[[methods]] +parent = "IRunAsyncView" +name = "RunTaskAsync" +sig = "Task RunTaskAsync(Func> function, object sender, JobSpecs? specs)" +returns = "Task" +file = "Mvvm\\Abstractions\\Interfaces\\IRunAsyncView.cs" + +[[interfaces]] +name = "IThreadingAwareViewModel" +ns = "FEx.Legacy.Mvvm.Abstractions.Interfaces" +base = "IRunAsync, IReactiveNotifyPropertyChanged, IHandleObservableErrors, IViewModelBase, IAsyncInitializable, ILinkableNotifyPropertyChanged" +file = "Mvvm\\Abstractions\\Interfaces\\IThreadingAwareViewModel.cs" + +[[properties]] +parent = "IThreadingAwareViewModel" +name = "IsUiUnlocked" +sig = "bool IsUiUnlocked { get; set; }" +returns = "bool" +summary = "Gets or sets a value indicating whether View instance related with this ViewModel is unlocked." +file = "Mvvm\\Abstractions\\Interfaces\\IThreadingAwareViewModel.cs" + +[[methods]] +parent = "IThreadingAwareViewModel" +name = "PostMainJob" +sig = "void PostMainJob(bool showTimeInfo)" +returns = "void" +file = "Mvvm\\Abstractions\\Interfaces\\IThreadingAwareViewModel.cs" + +[[methods]] +parent = "IThreadingAwareViewModel" +name = "PreMainJob" +sig = "void PreMainJob()" +returns = "void" +file = "Mvvm\\Abstractions\\Interfaces\\IThreadingAwareViewModel.cs" + diff --git a/.api-surface/FEx/Logging.Abstractions.toml b/.api-surface/FEx/Logging.Abstractions.toml index 8fef313d..98722aaa 100644 --- a/.api-surface/FEx/Logging.Abstractions.toml +++ b/.api-surface/FEx/Logging.Abstractions.toml @@ -8,18 +8,96 @@ ns = "FEx.Logging.Abstractions" base = "StaticsBase" file = "FExLoggingStatics.cs" +[[properties]] +parent = "FExLoggingStatics" +name = "LoggerFactory" +sig = "static ILoggerFactory LoggerFactory { get; }" +returns = "ILoggerFactory" +summary = "Retrieves the instance. ⚠️ This is discouraged and should only be used where Dependency Injection is unavailable." +file = "FExLoggingStatics.cs" +static = true + +[[methods]] +parent = "FExLoggingStatics" +name = "SetDefaults" +sig = "static void SetDefaults()" +returns = "void" +file = "FExLoggingStatics.cs" +static = true + +[[methods]] +parent = "FExLoggingStatics" +name = "Configure" +sig = "static void Configure(Func loggerFactoryFactory = null)" +returns = "void" +file = "FExLoggingStatics.cs" +static = true + +[[methods]] +parent = "FExLoggingStatics" +name = "Initialize" +sig = "static void Initialize(ILoggerFactory loggerFactory, ILogger logger = null)" +returns = "void" +file = "FExLoggingStatics.cs" +static = true + [[classes]] name = "SentrySinkConfiguratorBase" ns = "FEx.Logging.Abstractions" base = "SinkConfiguratorBase" file = "SentrySinkConfiguratorBase.cs" +[[ctors]] +parent = "SentrySinkConfiguratorBase" +sig = "SentrySinkConfiguratorBase(ISentryConfig sentryConfig, ILoggingConfiguration loggingConfiguration, IAppVersionProvider appVersionProvider)" +file = "SentrySinkConfiguratorBase.cs" + +[[methods]] +parent = "SentrySinkConfiguratorBase" +name = "ConfigureSentrySerilogLogging" +sig = "void ConfigureSentrySerilogLogging(SentrySerilogOptions options)" +returns = "void" +file = "SentrySinkConfiguratorBase.cs" + +[[methods]] +parent = "SentrySinkConfiguratorBase" +name = "ConfigureSentryLogging" +sig = "void ConfigureSentryLogging(SentryOptions options)" +returns = "void" +file = "SentrySinkConfiguratorBase.cs" + [[classes]] name = "SinkConfiguratorBase" ns = "FEx.Logging.Abstractions" base = "ISinkConfigurator" file = "SinkConfiguratorBase.cs" +[[properties]] +parent = "SinkConfiguratorBase" +name = "IsEnabled" +sig = "bool IsEnabled { get; }" +returns = "bool" +file = "SinkConfiguratorBase.cs" + +[[properties]] +parent = "SinkConfiguratorBase" +name = "SinkType" +sig = "LoggingOptions SinkType { get; }" +returns = "LoggingOptions" +file = "SinkConfiguratorBase.cs" + +[[ctors]] +parent = "SinkConfiguratorBase" +sig = "SinkConfiguratorBase(ILoggingConfiguration loggingConfiguration, LoggingOptions sinkType)" +file = "SinkConfiguratorBase.cs" + +[[methods]] +parent = "SinkConfiguratorBase" +name = "ConfigureSink" +sig = "LoggerConfiguration ConfigureSink(LoggerSinkConfiguration writeTo)" +returns = "LoggerConfiguration" +file = "SinkConfiguratorBase.cs" + [[enums]] name = "LoggingOptions" ns = "FEx.Logging.Abstractions.Enums" @@ -33,22 +111,32 @@ static = true [[extensions]] name = "AddOverrides" -sig = "LoggerConfiguration AddOverrides(this LoggerConfiguration cfg, - IList overrides, - LogEventLevel level)" returns = "LoggerConfiguration" +sig = "LoggerConfiguration AddOverrides(this LoggerConfiguration cfg, IList overrides, LogEventLevel level)" file = "Extensions\\LoggerExtensions.cs" [[extensions]] name = "Log" +returns = "void" sig = "void Log(this ILogger logger, LogLevel logLevel, string message, Exception exception = null)" +file = "Extensions\\LoggerExtensions.cs" + +[[extensions]] +name = "LogError" returns = "void" +sig = "void LogError(this ILogger logger, T exception)" file = "Extensions\\LoggerExtensions.cs" [[extensions]] name = "GetMicrosoftLogger" -sig = "ILogger GetMicrosoftLogger(this object sender)" returns = "ILogger" +sig = "ILogger GetMicrosoftLogger(this object sender)" +file = "Extensions\\LoggerExtensions.cs" + +[[extensions]] +name = "GetSerilogLogger" +returns = "Serilog.ILogger" +sig = "Serilog.ILogger GetSerilogLogger(this object sender)" file = "Extensions\\LoggerExtensions.cs" [[classes]] @@ -59,18 +147,69 @@ static = true [[extensions]] name = "HasFlagFast" -sig = "bool HasFlagFast(this LoggingOptions value, LoggingOptions flag)" returns = "bool" +sig = "bool HasFlagFast(this LoggingOptions value, LoggingOptions flag)" file = "Extensions\\LoggingOptionsExtensions.cs" [[interfaces]] name = "IFExLoggingConfigurator" ns = "FEx.Logging.Abstractions.Interfaces" +base = "IConfigurator" +file = "Interfaces\\IFExLoggingConfigurator.cs" + +[[properties]] +parent = "IFExLoggingConfigurator" +name = "IsLoggingEnabled" +sig = "bool IsLoggingEnabled { get; }" +returns = "bool" +file = "Interfaces\\IFExLoggingConfigurator.cs" + +[[properties]] +parent = "IFExLoggingConfigurator" +name = "Overrides" +sig = "IList Overrides { get; set; }" +returns = "IList" +file = "Interfaces\\IFExLoggingConfigurator.cs" + +[[properties]] +parent = "IFExLoggingConfigurator" +name = "ExternalLoggingLevel" +sig = "LogEventLevel ExternalLoggingLevel { get; set; }" +returns = "LogEventLevel" +file = "Interfaces\\IFExLoggingConfigurator.cs" + +[[properties]] +parent = "IFExLoggingConfigurator" +name = "ExternalDebugLoggingLevel" +sig = "LogEventLevel ExternalDebugLoggingLevel { get; set; }" +returns = "LogEventLevel" +file = "Interfaces\\IFExLoggingConfigurator.cs" + +[[properties]] +parent = "IFExLoggingConfigurator" +name = "CfgFunc" +sig = "Func CfgFunc { get; set; }" +returns = "Func" +file = "Interfaces\\IFExLoggingConfigurator.cs" + +[[properties]] +parent = "IFExLoggingConfigurator" +name = "Configuration" +sig = "LoggerConfiguration Configuration { get; }" +returns = "LoggerConfiguration" +file = "Interfaces\\IFExLoggingConfigurator.cs" + +[[methods]] +parent = "IFExLoggingConfigurator" +name = "GetLogFiles" +sig = "IEnumerable GetLogFiles()" +returns = "IEnumerable" file = "Interfaces\\IFExLoggingConfigurator.cs" [[interfaces]] name = "IFExLoggingContainer" ns = "FEx.Logging.Abstractions.Interfaces" +base = "IContainer, IContainer, IContainer, IContainer, IContainer, IContainer, IContainer, IContainer, IContainer" file = "Interfaces\\IFExLoggingContainer.cs" [[interfaces]] @@ -78,9 +217,129 @@ name = "IFExLoggingService" ns = "FEx.Logging.Abstractions.Interfaces" file = "Interfaces\\IFExLoggingService.cs" +[[methods]] +parent = "IFExLoggingService" +name = "GetLogger" +sig = "IFExLogger GetLogger()" +returns = "IFExLogger" +file = "Interfaces\\IFExLoggingService.cs" + +[[methods]] +parent = "IFExLoggingService" +name = "GetLogger" +sig = "IFExLogger GetLogger(object sender)" +returns = "IFExLogger" +file = "Interfaces\\IFExLoggingService.cs" + +[[methods]] +parent = "IFExLoggingService" +name = "LogCritical" +sig = "void LogCritical(string message, Exception exception = null)" +returns = "void" +file = "Interfaces\\IFExLoggingService.cs" + +[[methods]] +parent = "IFExLoggingService" +name = "LogDebug" +sig = "void LogDebug(string message, Exception exception = null)" +returns = "void" +file = "Interfaces\\IFExLoggingService.cs" + +[[methods]] +parent = "IFExLoggingService" +name = "LogError" +sig = "void LogError(string message, Exception exception = null)" +returns = "void" +file = "Interfaces\\IFExLoggingService.cs" + +[[methods]] +parent = "IFExLoggingService" +name = "LogInformation" +sig = "void LogInformation(string message, Exception exception = null)" +returns = "void" +file = "Interfaces\\IFExLoggingService.cs" + +[[methods]] +parent = "IFExLoggingService" +name = "LogTrace" +sig = "void LogTrace(string message, Exception exception = null)" +returns = "void" +file = "Interfaces\\IFExLoggingService.cs" + +[[methods]] +parent = "IFExLoggingService" +name = "LogWarning" +sig = "void LogWarning(string message, Exception exception = null)" +returns = "void" +file = "Interfaces\\IFExLoggingService.cs" + +[[methods]] +parent = "IFExLoggingService" +name = "Log" +sig = "void Log(LogLevel logLevel, string message, Exception exception = null)" +returns = "void" +file = "Interfaces\\IFExLoggingService.cs" + +[[methods]] +parent = "IFExLoggingService" +name = "LogCritical" +sig = "void LogCritical(object sender, string message, Exception exception = null)" +returns = "void" +file = "Interfaces\\IFExLoggingService.cs" + +[[methods]] +parent = "IFExLoggingService" +name = "LogDebug" +sig = "void LogDebug(object sender, string message, Exception exception = null)" +returns = "void" +file = "Interfaces\\IFExLoggingService.cs" + +[[methods]] +parent = "IFExLoggingService" +name = "LogError" +sig = "void LogError(object sender, string message, Exception exception = null)" +returns = "void" +file = "Interfaces\\IFExLoggingService.cs" + +[[methods]] +parent = "IFExLoggingService" +name = "LogInformation" +sig = "void LogInformation(object sender, string message, Exception exception = null)" +returns = "void" +file = "Interfaces\\IFExLoggingService.cs" + +[[methods]] +parent = "IFExLoggingService" +name = "LogTrace" +sig = "void LogTrace(object sender, string message, Exception exception = null)" +returns = "void" +file = "Interfaces\\IFExLoggingService.cs" + +[[methods]] +parent = "IFExLoggingService" +name = "LogWarning" +sig = "void LogWarning(object sender, string message, Exception exception = null)" +returns = "void" +file = "Interfaces\\IFExLoggingService.cs" + +[[methods]] +parent = "IFExLoggingService" +name = "Log" +sig = "void Log(object sender, LogLevel logLevel, string message, Exception exception = null)" +returns = "void" +file = "Interfaces\\IFExLoggingService.cs" + [[interfaces]] name = "IFileSinkConfigurator" ns = "FEx.Logging.Abstractions.Interfaces" +base = "ISinkConfigurator" +file = "Interfaces\\IFileSinkConfigurator.cs" + +[[methods]] +parent = "IFileSinkConfigurator" +name = "GetLogFiles" +sig = "IEnumerable GetLogFiles()" +returns = "IEnumerable" file = "Interfaces\\IFileSinkConfigurator.cs" [[interfaces]] @@ -88,18 +347,102 @@ name = "ILoggingConfiguration" ns = "FEx.Logging.Abstractions.Interfaces" file = "Interfaces\\ILoggingConfiguration.cs" +[[properties]] +parent = "ILoggingConfiguration" +name = "IsLoggingEnabled" +sig = "bool IsLoggingEnabled { get; }" +returns = "bool" +file = "Interfaces\\ILoggingConfiguration.cs" + +[[methods]] +parent = "ILoggingConfiguration" +name = "Configure" +sig = "void Configure(Func configurator)" +returns = "void" +file = "Interfaces\\ILoggingConfiguration.cs" + +[[methods]] +parent = "ILoggingConfiguration" +name = "EnableLogOption" +sig = "void EnableLogOption(LoggingOptions option)" +returns = "void" +file = "Interfaces\\ILoggingConfiguration.cs" + +[[methods]] +parent = "ILoggingConfiguration" +name = "DisableLogOption" +sig = "void DisableLogOption(LoggingOptions option)" +returns = "void" +file = "Interfaces\\ILoggingConfiguration.cs" + +[[methods]] +parent = "ILoggingConfiguration" +name = "HasOption" +sig = "bool HasOption(LoggingOptions option)" +returns = "bool" +file = "Interfaces\\ILoggingConfiguration.cs" + [[interfaces]] name = "IPlatformLogger" ns = "FEx.Logging.Abstractions.Interfaces" file = "Interfaces\\IPlatformLogger.cs" +[[methods]] +parent = "IPlatformLogger" +name = "Log" +sig = "void Log(string message, LogEvent logEvent)" +returns = "void" +file = "Interfaces\\IPlatformLogger.cs" + [[interfaces]] name = "ISentryConfig" ns = "FEx.Logging.Abstractions.Interfaces" file = "Interfaces\\ISentryConfig.cs" +[[properties]] +parent = "ISentryConfig" +name = "SentryDsn" +sig = "string SentryDsn { get; }" +returns = "string" +file = "Interfaces\\ISentryConfig.cs" + +[[properties]] +parent = "ISentryConfig" +name = "AttachScreenshot" +sig = "bool AttachScreenshot { get; }" +returns = "bool" +file = "Interfaces\\ISentryConfig.cs" + +[[properties]] +parent = "ISentryConfig" +name = "EnvironmentId" +sig = "string EnvironmentId { get; }" +returns = "string" +file = "Interfaces\\ISentryConfig.cs" + [[interfaces]] name = "ISinkConfigurator" ns = "FEx.Logging.Abstractions.Interfaces" file = "Interfaces\\ISinkConfigurator.cs" +[[properties]] +parent = "ISinkConfigurator" +name = "IsEnabled" +sig = "bool IsEnabled { get; }" +returns = "bool" +file = "Interfaces\\ISinkConfigurator.cs" + +[[properties]] +parent = "ISinkConfigurator" +name = "SinkType" +sig = "LoggingOptions SinkType { get; }" +returns = "LoggingOptions" +file = "Interfaces\\ISinkConfigurator.cs" + +[[methods]] +parent = "ISinkConfigurator" +name = "ConfigureSink" +sig = "LoggerConfiguration ConfigureSink(LoggerSinkConfiguration writeTo)" +returns = "LoggerConfiguration" +file = "Interfaces\\ISinkConfigurator.cs" + diff --git a/.api-surface/FEx/Logging.Tests.toml b/.api-surface/FEx/Logging.Tests.toml index e2e5ec06..40e44d93 100644 --- a/.api-surface/FEx/Logging.Tests.toml +++ b/.api-surface/FEx/Logging.Tests.toml @@ -8,22 +8,78 @@ ns = "FEx.Logging.Tests" summary = "Basic tests to validate the Logging module works correctly. Tests the container directly instead of relying on static FExServiceProvider." file = "BasicLoggingTests.cs" +[[methods]] +parent = "BasicLoggingTests" +name = "LoggingTypes_ShouldBeAvailable" +sig = "void LoggingTypes_ShouldBeAvailable()" +returns = "void" +file = "BasicLoggingTests.cs" + +[[methods]] +parent = "BasicLoggingTests" +name = "SerilogConfiguration_StaticMethodShouldExist" +sig = "void SerilogConfiguration_StaticMethodShouldExist()" +returns = "void" +file = "BasicLoggingTests.cs" + +[[methods]] +parent = "BasicLoggingTests" +name = "LoggingModule_ShouldSupportEngineAgnosticPattern" +sig = "void LoggingModule_ShouldSupportEngineAgnosticPattern()" +returns = "void" +file = "BasicLoggingTests.cs" + +[[methods]] +parent = "BasicLoggingTests" +name = "EngineAgnosticPattern_ShouldSupportFutureEngines" +sig = "void EngineAgnosticPattern_ShouldSupportFutureEngines()" +returns = "void" +file = "BasicLoggingTests.cs" + [[classes]] name = "LoggingConfigurationTests" ns = "FEx.Logging.Tests" file = "LoggingConfigurationTests.cs" +[[methods]] +parent = "LoggingConfigurationTests" +name = "LoggingModule_ShouldResolveAllRequiredServices" +sig = "void LoggingModule_ShouldResolveAllRequiredServices()" +returns = "void" +file = "LoggingConfigurationTests.cs" + [[classes]] name = "SerilogConfigurationTests" ns = "FEx.Logging.Tests" summary = "Tests to verify Serilog is correctly configured via IFExLoggingConfigurator." file = "SerilogConfigurationTests.cs" +[[methods]] +parent = "SerilogConfigurationTests" +name = "LoggingConfigurator_ShouldAllowPropertyConfiguration" +sig = "void LoggingConfigurator_ShouldAllowPropertyConfiguration()" +returns = "void" +file = "SerilogConfigurationTests.cs" + [[classes]] name = "TestContainer" ns = "FEx.Logging.Tests" -base = "TestBase, IFExLoggingContainer, IFExDependencyInjectionContainer, - IFExCoreContainer, IContainer, IContainer, - IContainer" +base = "TestBase, IFExLoggingContainer, IFExDependencyInjectionContainer, IFExCoreContainer, IContainer, IContainer, IContainer" +file = "TestContainer.cs" + +[[methods]] +parent = "TestContainer" +name = "CreateLogger" +sig = "static ILogger CreateLogger()" +returns = "ILogger" +file = "TestContainer.cs" +static = true + +[[methods]] +parent = "TestContainer" +name = "CreateSentryConfig" +sig = "static ISentryConfig CreateSentryConfig()" +returns = "ISentryConfig" file = "TestContainer.cs" +static = true diff --git a/.api-surface/FEx/Logging.Web.toml b/.api-surface/FEx/Logging.Web.toml index 44437a87..37a15ff3 100644 --- a/.api-surface/FEx/Logging.Web.toml +++ b/.api-surface/FEx/Logging.Web.toml @@ -10,7 +10,7 @@ static = true [[extensions]] name = "AddFExSerilog" -sig = "WebApplicationBuilder AddFExSerilog(this WebApplicationBuilder builder)" returns = "WebApplicationBuilder" +sig = "WebApplicationBuilder AddFExSerilog(this WebApplicationBuilder builder)" file = "FExSerilogWebExtensions.cs" diff --git a/.api-surface/FEx/Logging.toml b/.api-surface/FEx/Logging.toml index d9480a24..639a1ba3 100644 --- a/.api-surface/FEx/Logging.toml +++ b/.api-surface/FEx/Logging.toml @@ -8,65 +8,739 @@ ns = "FEx.Logging" base = "IPlatformLogger" file = "DefaultPlatformLogger.cs" +[[methods]] +parent = "DefaultPlatformLogger" +name = "Log" +sig = "void Log(string message, LogEvent logEvent)" +returns = "void" +file = "DefaultPlatformLogger.cs" + [[classes]] name = "FExLoggingConfigurator" ns = "FEx.Logging" base = "IFExLoggingConfigurator" file = "FExLoggingConfigurator.cs" +[[properties]] +parent = "FExLoggingConfigurator" +name = "IsLoggingEnabled" +sig = "bool IsLoggingEnabled { get; }" +returns = "bool" +file = "FExLoggingConfigurator.cs" + +[[properties]] +parent = "FExLoggingConfigurator" +name = "Priority" +sig = "ConfigurationPriority Priority { get; }" +returns = "ConfigurationPriority" +file = "FExLoggingConfigurator.cs" + +[[properties]] +parent = "FExLoggingConfigurator" +name = "Overrides" +sig = "IList Overrides { get; set; }" +returns = "IList" +file = "FExLoggingConfigurator.cs" + +[[properties]] +parent = "FExLoggingConfigurator" +name = "ExternalLoggingLevel" +sig = "LogEventLevel ExternalLoggingLevel { get; set; }" +returns = "LogEventLevel" +file = "FExLoggingConfigurator.cs" + +[[properties]] +parent = "FExLoggingConfigurator" +name = "ExternalDebugLoggingLevel" +sig = "LogEventLevel ExternalDebugLoggingLevel { get; set; }" +returns = "LogEventLevel" +file = "FExLoggingConfigurator.cs" + +[[properties]] +parent = "FExLoggingConfigurator" +name = "CfgFunc" +sig = "Func CfgFunc { get; set; }" +returns = "Func" +file = "FExLoggingConfigurator.cs" + +[[properties]] +parent = "FExLoggingConfigurator" +name = "Configuration" +sig = "LoggerConfiguration Configuration { get; }" +returns = "LoggerConfiguration" +file = "FExLoggingConfigurator.cs" + +[[ctors]] +parent = "FExLoggingConfigurator" +sig = "FExLoggingConfigurator(ILoggingConfiguration loggingConfiguration, ISinkConfigurator[] sinkConfigurators)" +file = "FExLoggingConfigurator.cs" + +[[methods]] +parent = "FExLoggingConfigurator" +name = "Configure" +sig = "void Configure()" +returns = "void" +file = "FExLoggingConfigurator.cs" + +[[methods]] +parent = "FExLoggingConfigurator" +name = "GetLogFiles" +sig = "IEnumerable GetLogFiles()" +returns = "IEnumerable" +file = "FExLoggingConfigurator.cs" + [[classes]] name = "FExLoggingModule" ns = "FEx.Logging" base = "InitializeModule" file = "FExLoggingModule.cs" +[[properties]] +parent = "FExLoggingModule" +name = "LoggerProviders" +sig = "static ILoggerProvider[] LoggerProviders { get; set; }" +returns = "ILoggerProvider[]" +file = "FExLoggingModule.cs" +static = true + +[[properties]] +parent = "FExLoggingModule" +name = "LoggingSrv" +sig = "static IFExLoggingService LoggingSrv { get; }" +returns = "IFExLoggingService" +file = "FExLoggingModule.cs" +static = true + +[[properties]] +parent = "FExLoggingModule" +name = "Configurator" +sig = "static IFExLoggingConfigurator Configurator { get; }" +returns = "IFExLoggingConfigurator" +file = "FExLoggingModule.cs" +static = true + +[[ctors]] +parent = "FExLoggingModule" +sig = "FExLoggingModule(IFExLoggingService loggingService, IFExLoggingConfigurator configurator)" +file = "FExLoggingModule.cs" + +[[methods]] +parent = "FExLoggingModule" +name = "GetSerilogLoggerFactory" +sig = "static ILoggerFactory GetSerilogLoggerFactory(LoggerProviderCollection providerCollection)" +returns = "ILoggerFactory" +file = "FExLoggingModule.cs" +static = true + +[[methods]] +parent = "FExLoggingModule" +name = "GetLoggerProviderCollection" +sig = "static LoggerProviderCollection GetLoggerProviderCollection(ILoggerProvider[] loggerProviders)" +returns = "LoggerProviderCollection" +summary = "Creating a `LoggerProviderCollection` lets Serilog optionally write events through other dynamically-added MEL ILoggerProviders." +file = "FExLoggingModule.cs" +static = true + +[[methods]] +parent = "FExLoggingModule" +name = "CreateLogger" +sig = "static ILogger CreateLogger(ILoggerFactory factory)" +returns = "ILogger" +file = "FExLoggingModule.cs" +static = true + +[[methods]] +parent = "FExLoggingModule" +name = "CreateLogger" +sig = "static ILogger CreateLogger(ILoggerFactory factory)" +returns = "ILogger" +file = "FExLoggingModule.cs" +static = true + +[[methods]] +parent = "FExLoggingModule" +name = "CreateLogger" +sig = "static ILogger CreateLogger()" +returns = "ILogger" +file = "FExLoggingModule.cs" +static = true + +[[methods]] +parent = "FExLoggingModule" +name = "CreateLogger" +sig = "static ILogger CreateLogger(Type senderType)" +returns = "ILogger" +file = "FExLoggingModule.cs" +static = true + +[[methods]] +parent = "FExLoggingModule" +name = "Log" +sig = "static void Log(string message, Type callerType, LogLevel level = LogLevel.Information, Exception exception = null)" +returns = "void" +file = "FExLoggingModule.cs" +static = true + +[[methods]] +parent = "FExLoggingModule" +name = "Log" +sig = "static void Log(string message, LogLevel level = LogLevel.Information, Exception exception = null)" +returns = "void" +file = "FExLoggingModule.cs" +static = true + +[[methods]] +parent = "FExLoggingModule" +name = "Configure" +sig = "static LoggerConfiguration Configure()" +returns = "LoggerConfiguration" +file = "FExLoggingModule.cs" +static = true + +[[methods]] +parent = "FExLoggingModule" +name = "OpenLogFile" +sig = "static void OpenLogFile()" +returns = "void" +file = "FExLoggingModule.cs" +static = true + +[[methods]] +parent = "FExLoggingModule" +name = "OnInitialize" +sig = "void OnInitialize()" +returns = "void" +file = "FExLoggingModule.cs" + +[[methods]] +parent = "FExLoggingModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExLoggingContainer container, IServiceCollection services)" +returns = "void" +file = "FExLoggingModule.cs" + [[classes]] name = "FExLoggingService" ns = "FEx.Logging" base = "IFExLoggingService" file = "FExLoggingService.cs" +[[properties]] +parent = "FExLoggingService" +name = "DefaultLogger" +sig = "ILogger DefaultLogger { get; }" +returns = "ILogger" +file = "FExLoggingService.cs" + +[[properties]] +parent = "FExLoggingService" +name = "Logger" +sig = "IFExLogger Logger { get; }" +returns = "IFExLogger" +file = "FExLoggingService.cs" + +[[ctors]] +parent = "FExLoggingService" +sig = "FExLoggingService(ILogger defaultLogger, IFExLogger logger)" +file = "FExLoggingService.cs" + +[[methods]] +parent = "FExLoggingService" +name = "GetLogger" +sig = "IFExLogger GetLogger()" +returns = "IFExLogger" +file = "FExLoggingService.cs" + +[[methods]] +parent = "FExLoggingService" +name = "GetLogger" +sig = "IFExLogger GetLogger(object sender)" +returns = "IFExLogger" +file = "FExLoggingService.cs" + +[[methods]] +parent = "FExLoggingService" +name = "LogCritical" +sig = "void LogCritical(string message, Exception exception = null)" +returns = "void" +file = "FExLoggingService.cs" + +[[methods]] +parent = "FExLoggingService" +name = "LogDebug" +sig = "void LogDebug(string message, Exception exception = null)" +returns = "void" +file = "FExLoggingService.cs" + +[[methods]] +parent = "FExLoggingService" +name = "LogError" +sig = "void LogError(string message, Exception exception = null)" +returns = "void" +file = "FExLoggingService.cs" + +[[methods]] +parent = "FExLoggingService" +name = "LogInformation" +sig = "void LogInformation(string message, Exception exception = null)" +returns = "void" +file = "FExLoggingService.cs" + +[[methods]] +parent = "FExLoggingService" +name = "LogTrace" +sig = "void LogTrace(string message, Exception exception = null)" +returns = "void" +file = "FExLoggingService.cs" + +[[methods]] +parent = "FExLoggingService" +name = "LogWarning" +sig = "void LogWarning(string message, Exception exception = null)" +returns = "void" +file = "FExLoggingService.cs" + +[[methods]] +parent = "FExLoggingService" +name = "Log" +sig = "void Log(LogLevel logLevel, string message, Exception exception = null)" +returns = "void" +file = "FExLoggingService.cs" + +[[methods]] +parent = "FExLoggingService" +name = "LogCritical" +sig = "void LogCritical(object sender, string message, Exception exception = null)" +returns = "void" +file = "FExLoggingService.cs" + +[[methods]] +parent = "FExLoggingService" +name = "LogDebug" +sig = "void LogDebug(object sender, string message, Exception exception = null)" +returns = "void" +file = "FExLoggingService.cs" + +[[methods]] +parent = "FExLoggingService" +name = "LogError" +sig = "void LogError(object sender, string message, Exception exception = null)" +returns = "void" +file = "FExLoggingService.cs" + +[[methods]] +parent = "FExLoggingService" +name = "LogInformation" +sig = "void LogInformation(object sender, string message, Exception exception = null)" +returns = "void" +file = "FExLoggingService.cs" + +[[methods]] +parent = "FExLoggingService" +name = "LogTrace" +sig = "void LogTrace(object sender, string message, Exception exception = null)" +returns = "void" +file = "FExLoggingService.cs" + +[[methods]] +parent = "FExLoggingService" +name = "LogWarning" +sig = "void LogWarning(object sender, string message, Exception exception = null)" +returns = "void" +file = "FExLoggingService.cs" + +[[methods]] +parent = "FExLoggingService" +name = "Log" +sig = "void Log(object sender, LogLevel logLevel, string message, Exception exception = null)" +returns = "void" +file = "FExLoggingService.cs" + [[classes]] name = "FExSerilogLogger" ns = "FEx.Logging" -base = "IFExLogger, IDisposable -#pragma warning restore IDISP025" +base = "IFExLogger, IDisposable" summary = "Serilog-backed implementation of IFExLogger. Maps Critical → Serilog.Fatal, implements structured logging via LogContext." file = "FExSerilogLogger.cs" +[[methods]] +parent = "FExSerilogLogger" +name = "Trace" +sig = "void Trace(string message)" +returns = "void" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "Trace" +sig = "void Trace(Exception exception, string message)" +returns = "void" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "Debug" +sig = "void Debug(string message)" +returns = "void" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "Debug" +sig = "void Debug(Exception exception, string message)" +returns = "void" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "Information" +sig = "void Information(string message)" +returns = "void" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "Information" +sig = "void Information(Exception exception, string message)" +returns = "void" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "Warning" +sig = "void Warning(string message)" +returns = "void" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "Warning" +sig = "void Warning(Exception exception, string message)" +returns = "void" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "Error" +sig = "void Error(string message)" +returns = "void" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "Error" +sig = "void Error(Exception exception, string message)" +returns = "void" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "Critical" +sig = "void Critical(string message)" +returns = "void" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "Critical" +sig = "void Critical(Exception exception, string message)" +returns = "void" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "BeginScope" +sig = "IDisposable BeginScope(TState state)" +returns = "IDisposable" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "BeginLabeledScope" +sig = "IDisposable BeginLabeledScope(params (string, object)[] state)" +returns = "IDisposable" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "BeginLabeledScope" +sig = "IDisposable BeginLabeledScope(IDictionary argsCustom)" +returns = "IDisposable" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "BeginLabeledScope" +sig = "IDisposable BeginLabeledScope(ILoggerState state)" +returns = "IDisposable" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "EndScope" +sig = "void EndScope()" +returns = "void" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "AddOrUpdateLabel" +sig = "void AddOrUpdateLabel(string key, object value)" +returns = "void" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "RemoveLabel" +sig = "void RemoveLabel(string key)" +returns = "void" +file = "FExSerilogLogger.cs" + +[[methods]] +parent = "FExSerilogLogger" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "FExSerilogLogger.cs" + [[classes]] name = "LoggingConfiguration" ns = "FEx.Logging" base = "ILoggingConfiguration" file = "LoggingConfiguration.cs" +[[properties]] +parent = "LoggingConfiguration" +name = "IsLoggingEnabled" +sig = "bool IsLoggingEnabled { get; }" +returns = "bool" +file = "LoggingConfiguration.cs" + +[[properties]] +parent = "LoggingConfiguration" +name = "Options" +sig = "LoggingOptions Options { get; }" +returns = "LoggingOptions" +file = "LoggingConfiguration.cs" + +[[ctors]] +parent = "LoggingConfiguration" +sig = "LoggingConfiguration()" +file = "LoggingConfiguration.cs" + +[[methods]] +parent = "LoggingConfiguration" +name = "EnableLogOption" +sig = "void EnableLogOption(LoggingOptions option)" +returns = "void" +file = "LoggingConfiguration.cs" + +[[methods]] +parent = "LoggingConfiguration" +name = "DisableLogOption" +sig = "void DisableLogOption(LoggingOptions option)" +returns = "void" +file = "LoggingConfiguration.cs" + +[[methods]] +parent = "LoggingConfiguration" +name = "HasOption" +sig = "bool HasOption(LoggingOptions option)" +returns = "bool" +file = "LoggingConfiguration.cs" + +[[methods]] +parent = "LoggingConfiguration" +name = "Configure" +sig = "void Configure(Func configurator)" +returns = "void" +file = "LoggingConfiguration.cs" + [[classes]] name = "PlatformSink" ns = "FEx.Logging.Sinks" base = "ILogEventSink" file = "Sinks\\PlatformSink.cs" +[[ctors]] +parent = "PlatformSink" +sig = "PlatformSink(ITextFormatter formatter, IPlatformLogger platformLogger)" +file = "Sinks\\PlatformSink.cs" + +[[methods]] +parent = "PlatformSink" +name = "Emit" +sig = "void Emit(LogEvent logEvent)" +returns = "void" +file = "Sinks\\PlatformSink.cs" + [[classes]] name = "AsyncFileSinkConfigurator" ns = "FEx.Logging.Sinks.Configurations" base = "SinkConfiguratorBase, IFileSinkConfigurator" file = "Sinks\\Configurations\\AsyncFileSinkConfigurator.cs" +[[properties]] +parent = "AsyncFileSinkConfigurator" +name = "OutputTemplate" +sig = "string OutputTemplate { get; set; }" +returns = "string" +file = "Sinks\\Configurations\\AsyncFileSinkConfigurator.cs" + +[[properties]] +parent = "AsyncFileSinkConfigurator" +name = "FileSizeLimitBytes" +sig = "int FileSizeLimitBytes { get; set; }" +returns = "int" +file = "Sinks\\Configurations\\AsyncFileSinkConfigurator.cs" + +[[properties]] +parent = "AsyncFileSinkConfigurator" +name = "RollingInterval" +sig = "RollingInterval RollingInterval { get; set; }" +returns = "RollingInterval" +file = "Sinks\\Configurations\\AsyncFileSinkConfigurator.cs" + +[[properties]] +parent = "AsyncFileSinkConfigurator" +name = "RetainedFileCountLimit" +sig = "int RetainedFileCountLimit { get; set; }" +returns = "int" +file = "Sinks\\Configurations\\AsyncFileSinkConfigurator.cs" + +[[properties]] +parent = "AsyncFileSinkConfigurator" +name = "RetainedFileTimeLimit" +sig = "TimeSpan RetainedFileTimeLimit { get; set; }" +returns = "TimeSpan" +file = "Sinks\\Configurations\\AsyncFileSinkConfigurator.cs" + +[[properties]] +parent = "AsyncFileSinkConfigurator" +name = "MinimumLevel" +sig = "LogEventLevel MinimumLevel { get; set; }" +returns = "LogEventLevel" +file = "Sinks\\Configurations\\AsyncFileSinkConfigurator.cs" + +[[properties]] +parent = "AsyncFileSinkConfigurator" +name = "LogFileName" +sig = "string LogFileName { get; set; }" +returns = "string" +file = "Sinks\\Configurations\\AsyncFileSinkConfigurator.cs" + +[[properties]] +parent = "AsyncFileSinkConfigurator" +name = "CustomLogFilePath" +sig = "string CustomLogFilePath { get; set; }" +returns = "string" +file = "Sinks\\Configurations\\AsyncFileSinkConfigurator.cs" + +[[ctors]] +parent = "AsyncFileSinkConfigurator" +sig = "AsyncFileSinkConfigurator(ILoggingConfiguration loggingConfiguration, IAppInfoProvider appInfoProvider)" +file = "Sinks\\Configurations\\AsyncFileSinkConfigurator.cs" + +[[methods]] +parent = "AsyncFileSinkConfigurator" +name = "GetLogFiles" +sig = "IEnumerable GetLogFiles()" +returns = "IEnumerable" +file = "Sinks\\Configurations\\AsyncFileSinkConfigurator.cs" + +[[methods]] +parent = "AsyncFileSinkConfigurator" +name = "ConfigureSink" +sig = "LoggerConfiguration ConfigureSink(LoggerSinkConfiguration writeTo)" +returns = "LoggerConfiguration" +file = "Sinks\\Configurations\\AsyncFileSinkConfigurator.cs" + [[classes]] name = "ConsoleSinkConfigurator" ns = "FEx.Logging.Sinks.Configurations" base = "SinkConfiguratorBase" file = "Sinks\\Configurations\\ConsoleSinkConfigurator.cs" +[[properties]] +parent = "ConsoleSinkConfigurator" +name = "OutputTemplate" +sig = "string OutputTemplate { get; set; }" +returns = "string" +file = "Sinks\\Configurations\\ConsoleSinkConfigurator.cs" + +[[properties]] +parent = "ConsoleSinkConfigurator" +name = "MinimumLevel" +sig = "LogEventLevel MinimumLevel { get; set; }" +returns = "LogEventLevel" +file = "Sinks\\Configurations\\ConsoleSinkConfigurator.cs" + +[[properties]] +parent = "ConsoleSinkConfigurator" +name = "Theme" +sig = "ConsoleTheme Theme { get; set; }" +returns = "ConsoleTheme" +file = "Sinks\\Configurations\\ConsoleSinkConfigurator.cs" + +[[ctors]] +parent = "ConsoleSinkConfigurator" +sig = "ConsoleSinkConfigurator(ILoggingConfiguration loggingConfiguration)" +file = "Sinks\\Configurations\\ConsoleSinkConfigurator.cs" + +[[methods]] +parent = "ConsoleSinkConfigurator" +name = "ConfigureSink" +sig = "LoggerConfiguration ConfigureSink(LoggerSinkConfiguration writeTo)" +returns = "LoggerConfiguration" +file = "Sinks\\Configurations\\ConsoleSinkConfigurator.cs" + [[classes]] name = "DebugSinkConfigurator" ns = "FEx.Logging.Sinks.Configurations" base = "SinkConfiguratorBase" file = "Sinks\\Configurations\\DebugSinkConfigurator.cs" +[[properties]] +parent = "DebugSinkConfigurator" +name = "OutputTemplate" +sig = "string OutputTemplate { get; set; }" +returns = "string" +file = "Sinks\\Configurations\\DebugSinkConfigurator.cs" + +[[properties]] +parent = "DebugSinkConfigurator" +name = "MinimumLevel" +sig = "LogEventLevel MinimumLevel { get; set; }" +returns = "LogEventLevel" +file = "Sinks\\Configurations\\DebugSinkConfigurator.cs" + +[[ctors]] +parent = "DebugSinkConfigurator" +sig = "DebugSinkConfigurator(ILoggingConfiguration loggingConfiguration)" +file = "Sinks\\Configurations\\DebugSinkConfigurator.cs" + +[[methods]] +parent = "DebugSinkConfigurator" +name = "ConfigureSink" +sig = "LoggerConfiguration ConfigureSink(LoggerSinkConfiguration writeTo)" +returns = "LoggerConfiguration" +file = "Sinks\\Configurations\\DebugSinkConfigurator.cs" + [[classes]] name = "PlatformSinkConfigurator" ns = "FEx.Logging.Sinks.Configurations" base = "SinkConfiguratorBase" file = "Sinks\\Configurations\\PlatformSinkConfigurator.cs" +[[ctors]] +parent = "PlatformSinkConfigurator" +sig = "PlatformSinkConfigurator(IPlatformLogger platformLogger, ILoggingConfiguration loggingConfiguration)" +file = "Sinks\\Configurations\\PlatformSinkConfigurator.cs" + +[[methods]] +parent = "PlatformSinkConfigurator" +name = "ConfigureSink" +sig = "LoggerConfiguration ConfigureSink(LoggerSinkConfiguration writeTo)" +returns = "LoggerConfiguration" +file = "Sinks\\Configurations\\PlatformSinkConfigurator.cs" + diff --git a/.api-surface/FEx/MSBuildx.toml b/.api-surface/FEx/MSBuildx.toml index ed6192a0..1aba6583 100644 --- a/.api-surface/FEx/MSBuildx.toml +++ b/.api-surface/FEx/MSBuildx.toml @@ -7,28 +7,540 @@ name = "DiffResult" ns = "FEx.MSBuildx" file = "DiffResult.cs" +[[properties]] +parent = "DiffResult" +name = "Info" +sig = "FileInfo Info { get; }" +returns = "FileInfo" +file = "DiffResult.cs" + +[[properties]] +parent = "DiffResult" +name = "RelativePath" +sig = "string RelativePath { get; }" +returns = "string" +file = "DiffResult.cs" + +[[properties]] +parent = "DiffResult" +name = "FullPath" +sig = "string FullPath { get; }" +returns = "string" +file = "DiffResult.cs" + +[[properties]] +parent = "DiffResult" +name = "Project" +sig = "MSProject Project { get; }" +returns = "MSProject" +file = "DiffResult.cs" + +[[properties]] +parent = "DiffResult" +name = "ItemType" +sig = "string ItemType { get; }" +returns = "string" +file = "DiffResult.cs" + +[[properties]] +parent = "DiffResult" +name = "Exists" +sig = "bool Exists { get; }" +returns = "bool" +file = "DiffResult.cs" + +[[properties]] +parent = "DiffResult" +name = "Length" +sig = "long Length { get; }" +returns = "long" +file = "DiffResult.cs" + +[[properties]] +parent = "DiffResult" +name = "Extension" +sig = "string Extension { get; }" +returns = "string" +file = "DiffResult.cs" + +[[ctors]] +parent = "DiffResult" +sig = "DiffResult(MSProject project, string relativePath = null, MSProjectItem item = null)" +file = "DiffResult.cs" + [[classes]] name = "MSProject" ns = "FEx.MSBuildx" file = "MSProject.cs" +[[properties]] +parent = "MSProject" +name = "PackageRefStr" +sig = "static string PackageRefStr { get; }" +returns = "string" +file = "MSProject.cs" +static = true + +[[properties]] +parent = "MSProject" +name = "IgnoredItemsNames" +sig = "static ImmutableHashSet IgnoredItemsNames { get; }" +returns = "ImmutableHashSet" +file = "MSProject.cs" +static = true + +[[properties]] +parent = "MSProject" +name = "AcceptedItemsNames" +sig = "static ConcurrentList AcceptedItemsNames { get; }" +returns = "ConcurrentList" +file = "MSProject.cs" +static = true + +[[properties]] +parent = "MSProject" +name = "Project" +sig = "Project Project { get; }" +returns = "Project" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "ProjectType" +sig = "SolutionProjectType ProjectType { get; }" +returns = "SolutionProjectType" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "IncludedFiles" +sig = "IList IncludedFiles { get; }" +returns = "IList" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "PropertiesDictionary" +sig = "Dictionary PropertiesDictionary { get; }" +returns = "Dictionary" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "Files" +sig = "ConcurrentList Files { get; }" +returns = "ConcurrentList" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "IgnoredDirectories" +sig = "IList IgnoredDirectories { get; }" +returns = "IList" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "IgnoredFiles" +sig = "IList IgnoredFiles { get; }" +returns = "IList" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "Name" +sig = "string Name { get; }" +returns = "string" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "AssemblyName" +sig = "string AssemblyName { get; }" +returns = "string" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "ProjectDir" +sig = "string ProjectDir { get; }" +returns = "string" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "ProjectFile" +sig = "string ProjectFile { get; }" +returns = "string" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "OutDir" +sig = "string OutDir { get; }" +returns = "string" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "OutDirPath" +sig = "string OutDirPath { get; }" +returns = "string" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "NuGetPackageRoot" +sig = "string NuGetPackageRoot { get; }" +returns = "string" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "MSBuildAllProjects" +sig = "IList MSBuildAllProjects { get; }" +returns = "IList" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "TargetFramework" +sig = "string TargetFramework { get; }" +returns = "string" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "IsNetCore3" +sig = "bool IsNetCore3 { get; }" +returns = "bool" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "InitialMSBuildProjectExtensionsPath" +sig = "string InitialMSBuildProjectExtensionsPath { get; }" +returns = "string" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "FullPath" +sig = "string FullPath { get; }" +returns = "string" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "MissingFiles" +sig = "ConcurrentList MissingFiles { get; }" +returns = "ConcurrentList" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "BinDir" +sig = "string BinDir { get; }" +returns = "string" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "PublishDirName" +sig = "string PublishDirName { get; }" +returns = "string" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "RuntimeIdentifier" +sig = "string RuntimeIdentifier { get; }" +returns = "string" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "Configurations" +sig = "IList Configurations { get; }" +returns = "IList" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "PublishDirs" +sig = "IDictionary PublishDirs { get; }" +returns = "IDictionary" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "NuGetPackages" +sig = "HashSet NuGetPackages { get; }" +returns = "HashSet" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "IsAspNetCore" +sig = "bool IsAspNetCore { get; }" +returns = "bool" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "IsNetCore" +sig = "bool IsNetCore { get; }" +returns = "bool" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "Company" +sig = "string Company { get; }" +returns = "string" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "PackageId" +sig = "string PackageId { get; }" +returns = "string" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "IsPackable" +sig = "bool IsPackable { get; }" +returns = "bool" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "Version" +sig = "string Version { get; }" +returns = "string" +file = "MSProject.cs" + +[[properties]] +parent = "MSProject" +name = "AllEvaluatedItems" +sig = "ICollection AllEvaluatedItems { get; }" +returns = "ICollection" +file = "MSProject.cs" + +[[ctors]] +parent = "MSProject" +sig = "MSProject(Project project, SolutionProjectType projectType, string solutionPackagesDir = null, bool is64Bit = false)" +file = "MSProject.cs" + +[[methods]] +parent = "MSProject" +name = "GetProjectOutputPath" +sig = "string GetProjectOutputPath(string buildConfiguration)" +returns = "string" +file = "MSProject.cs" + +[[methods]] +parent = "MSProject" +name = "SetPackageVersion" +sig = "void SetPackageVersion(string version)" +returns = "void" +file = "MSProject.cs" + [[classes]] name = "MSProjectItem" ns = "FEx.MSBuildx" file = "MSProjectItem.cs" +[[properties]] +parent = "MSProjectItem" +name = "ProjectItemTypes" +sig = "static IMap ProjectItemTypes { get; }" +returns = "IMap" +file = "MSProjectItem.cs" +static = true + +[[properties]] +parent = "MSProjectItem" +name = "ProjectItem" +sig = "ProjectItem ProjectItem { get; }" +returns = "ProjectItem" +file = "MSProjectItem.cs" + +[[properties]] +parent = "MSProjectItem" +name = "FullPath" +sig = "string FullPath { get; }" +returns = "string" +file = "MSProjectItem.cs" + +[[properties]] +parent = "MSProjectItem" +name = "Extension" +sig = "string Extension { get; }" +returns = "string" +file = "MSProjectItem.cs" + +[[properties]] +parent = "MSProjectItem" +name = "ProjectItemType" +sig = "ProjectItemType? ProjectItemType { get; }" +returns = "ProjectItemType?" +file = "MSProjectItem.cs" + +[[properties]] +parent = "MSProjectItem" +name = "ItemType" +sig = "string ItemType { get; }" +returns = "string" +file = "MSProjectItem.cs" + +[[properties]] +parent = "MSProjectItem" +name = "EvaluatedInclude" +sig = "string EvaluatedInclude { get; }" +returns = "string" +file = "MSProjectItem.cs" + +[[properties]] +parent = "MSProjectItem" +name = "UnevaluatedInclude" +sig = "string UnevaluatedInclude { get; }" +returns = "string" +file = "MSProjectItem.cs" + +[[properties]] +parent = "MSProjectItem" +name = "DirectMetadataCount" +sig = "int DirectMetadataCount { get; }" +returns = "int" +file = "MSProjectItem.cs" + +[[ctors]] +parent = "MSProjectItem" +sig = "MSProjectItem(ProjectItem projectItem, MSProject project)" +file = "MSProjectItem.cs" + [[classes]] name = "MSProjectNuGetInstallation" ns = "FEx.MSBuildx" base = "NuGetPackageInstallation, IDisposable" file = "MSProjectNuGetInstallation.cs" +[[properties]] +parent = "MSProjectNuGetInstallation" +name = "MSProjects" +sig = "ConcurrentObservableList MSProjects { get; }" +returns = "ConcurrentObservableList" +file = "MSProjectNuGetInstallation.cs" + +[[properties]] +parent = "MSProjectNuGetInstallation" +name = "Projects" +sig = "string Projects { get; }" +returns = "string" +file = "MSProjectNuGetInstallation.cs" + +[[ctors]] +parent = "MSProjectNuGetInstallation" +sig = "MSProjectNuGetInstallation(PackageIdentity package)" +file = "MSProjectNuGetInstallation.cs" + +[[methods]] +parent = "MSProjectNuGetInstallation" +name = "AddProject" +sig = "void AddProject(MSProject project)" +returns = "void" +file = "MSProjectNuGetInstallation.cs" + +[[methods]] +parent = "MSProjectNuGetInstallation" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "MSProjectNuGetInstallation.cs" + [[classes]] name = "MSSolution" ns = "FEx.MSBuildx" base = "AsyncInitializable" file = "MSSolution.cs" +[[properties]] +parent = "MSSolution" +name = "SolutionDir" +sig = "string SolutionDir { get; }" +returns = "string" +file = "MSSolution.cs" + +[[properties]] +parent = "MSSolution" +name = "Projects" +sig = "IReadOnlyList Projects { get; }" +returns = "IReadOnlyList" +file = "MSSolution.cs" + +[[properties]] +parent = "MSSolution" +name = "Solution" +sig = "SolutionFile Solution { get; }" +returns = "SolutionFile" +file = "MSSolution.cs" + +[[properties]] +parent = "MSSolution" +name = "SolutionFilePath" +sig = "string SolutionFilePath { get; }" +returns = "string" +file = "MSSolution.cs" + +[[properties]] +parent = "MSSolution" +name = "Name" +sig = "string Name { get; }" +returns = "string" +file = "MSSolution.cs" + +[[properties]] +parent = "MSSolution" +name = "SolutionPackagesDir" +sig = "string SolutionPackagesDir { get; }" +returns = "string" +file = "MSSolution.cs" + +[[properties]] +parent = "MSSolution" +name = "NuGetPackages" +sig = "ConcurrentDictionary> NuGetPackages { get; }" +returns = "ConcurrentDictionary>" +file = "MSSolution.cs" + +[[properties]] +parent = "MSSolution" +name = "InstalledNuGetPackages" +sig = "ConcurrentObservableList InstalledNuGetPackages { get; }" +returns = "ConcurrentObservableList" +file = "MSSolution.cs" + +[[properties]] +parent = "MSSolution" +name = "ProjectsList" +sig = "ConcurrentList ProjectsList { get; }" +returns = "ConcurrentList" +file = "MSSolution.cs" + +[[ctors]] +parent = "MSSolution" +sig = "MSSolution(string solutionFile)" +file = "MSSolution.cs" + +[[methods]] +parent = "MSSolution" +name = "OnInitializeAsync" +sig = "Task OnInitializeAsync()" +returns = "Task" +file = "MSSolution.cs" + [[enums]] name = "ProjectItemType" ns = "FEx.MSBuildx" @@ -42,7 +554,15 @@ static = true [[extensions]] name = "FromFile" +returns = "MSProject" sig = "MSProject FromFile(this ProjectInSolution projectInSolution, string solutionPackagesDir = null)" +file = "Extensions\\MSBuildExtensions.cs" + +[[methods]] +parent = "MSBuildExtensions" +name = "FromFile" +sig = "static MSProject FromFile(string projectFilePath, SolutionProjectType projectType, string solutionPackagesDir = null)" returns = "MSProject" file = "Extensions\\MSBuildExtensions.cs" +static = true diff --git a/.api-surface/FEx/MVVM.Abstractions.toml b/.api-surface/FEx/MVVM.Abstractions.toml index 2f043935..1c1e5e7d 100644 --- a/.api-surface/FEx/MVVM.Abstractions.toml +++ b/.api-surface/FEx/MVVM.Abstractions.toml @@ -8,52 +8,566 @@ ns = "FEx.MVVM.Abstractions" base = "IMessagePopupService" file = "DummyPopupService.cs" +[[properties]] +parent = "DummyPopupService" +name = "AppIsClosing" +sig = "bool AppIsClosing { get; set; }" +returns = "bool" +file = "DummyPopupService.cs" + +[[methods]] +parent = "DummyPopupService" +name = "ShowMessageAsync" +sig = "Task ShowMessageAsync(string txt, string caption, MessageIcon messageBoxImage, FExMessageButton button, ISupportInitialize ownerWindow, bool informUser, bool wait, Stopwatch sw, LogLevel level, Exception exception)" +returns = "Task" +file = "DummyPopupService.cs" + +[[methods]] +parent = "DummyPopupService" +name = "ShowMessage" +sig = "MessageResult ShowMessage(string txt, string caption, MessageIcon messageBoxImage, FExMessageButton button, ISupportInitialize ownerWindow, bool informUser, bool wait, Stopwatch sw, LogLevel level, Exception exception)" +returns = "MessageResult" +file = "DummyPopupService.cs" + [[classes]] name = "FExTreeViewNode" ns = "FEx.MVVM.Abstractions" base = "IEquatable" file = "FExTreeViewNode.cs" +[[properties]] +parent = "FExTreeViewNode" +name = "ForbiddenItemNameChars" +sig = "static string[] ForbiddenItemNameChars { get; }" +returns = "string[]" +file = "FExTreeViewNode.cs" +static = true + +[[properties]] +parent = "FExTreeViewNode" +name = "DefaultDirectoryPathForIcon" +sig = "static string DefaultDirectoryPathForIcon { get; }" +returns = "string" +file = "FExTreeViewNode.cs" +static = true + +[[properties]] +parent = "FExTreeViewNode" +name = "IsIconAttachedToFile" +sig = "bool IsIconAttachedToFile { get; }" +returns = "bool" +file = "FExTreeViewNode.cs" + +[[properties]] +parent = "FExTreeViewNode" +name = "NodePath" +sig = "List NodePath { get; }" +returns = "List" +file = "FExTreeViewNode.cs" + +[[properties]] +parent = "FExTreeViewNode" +name = "NodeName" +sig = "string NodeName { get; }" +returns = "string" +file = "FExTreeViewNode.cs" + +[[properties]] +parent = "FExTreeViewNode" +name = "NodeHeader" +sig = "string NodeHeader { get; }" +returns = "string" +file = "FExTreeViewNode.cs" + +[[properties]] +parent = "FExTreeViewNode" +name = "ChildNodes" +sig = "ConcurrentList ChildNodes { get; }" +returns = "ConcurrentList" +file = "FExTreeViewNode.cs" + +[[properties]] +parent = "FExTreeViewNode" +name = "IconPath" +sig = "string IconPath { get; }" +returns = "string" +file = "FExTreeViewNode.cs" + +[[properties]] +parent = "FExTreeViewNode" +name = "IsExpanded" +sig = "bool IsExpanded { get; }" +returns = "bool" +file = "FExTreeViewNode.cs" + +[[ctors]] +parent = "FExTreeViewNode" +sig = "FExTreeViewNode(string path)" +file = "FExTreeViewNode.cs" + +[[ctors]] +parent = "FExTreeViewNode" +sig = "FExTreeViewNode(string path, string name)" +file = "FExTreeViewNode.cs" + +[[ctors]] +parent = "FExTreeViewNode" +sig = "FExTreeViewNode(string path, string name, char pathSeparator)" +file = "FExTreeViewNode.cs" + +[[ctors]] +parent = "FExTreeViewNode" +sig = "FExTreeViewNode(string path, string name, char pathSeparator, string iconPath, bool isIconAttachedToFile, bool isExpanded)" +file = "FExTreeViewNode.cs" + +[[ctors]] +parent = "FExTreeViewNode" +sig = "FExTreeViewNode(List path)" +file = "FExTreeViewNode.cs" + +[[ctors]] +parent = "FExTreeViewNode" +sig = "FExTreeViewNode(List path, string name)" +file = "FExTreeViewNode.cs" + +[[ctors]] +parent = "FExTreeViewNode" +sig = "FExTreeViewNode(List path, string name, string iconPath)" +file = "FExTreeViewNode.cs" + +[[ctors]] +parent = "FExTreeViewNode" +sig = "FExTreeViewNode(List path, string name, string iconPath, bool isIconAttachedToFile, bool isExpanded)" +file = "FExTreeViewNode.cs" + +[[methods]] +parent = "FExTreeViewNode" +name = "GetNodePath" +sig = "static List GetNodePath(string nodePath)" +returns = "List" +file = "FExTreeViewNode.cs" +static = true + +[[methods]] +parent = "FExTreeViewNode" +name = "GetNodePath" +sig = "static List GetNodePath(string nodePath, char pathSeparator)" +returns = "List" +file = "FExTreeViewNode.cs" +static = true + +[[methods]] +parent = "FExTreeViewNode" +name = "FixTreeViewItemName" +sig = "static string FixTreeViewItemName(string name)" +returns = "string" +file = "FExTreeViewNode.cs" +static = true + +[[methods]] +parent = "FExTreeViewNode" +name = "FixTreeViewItemName" +sig = "static string FixTreeViewItemName(string name, string replacement)" +returns = "string" +file = "FExTreeViewNode.cs" +static = true + +[[methods]] +parent = "FExTreeViewNode" +name = "GetIconCacheKey" +sig = "string GetIconCacheKey()" +returns = "string" +file = "FExTreeViewNode.cs" + +[[methods]] +parent = "FExTreeViewNode" +name = "AddChildNode" +sig = "void AddChildNode(string nodePath)" +returns = "void" +file = "FExTreeViewNode.cs" + +[[methods]] +parent = "FExTreeViewNode" +name = "AddChildNode" +sig = "void AddChildNode(string nodePath, string name, char pathSeparator, bool unique, string iconPath, bool isExpanded)" +returns = "void" +file = "FExTreeViewNode.cs" + +[[methods]] +parent = "FExTreeViewNode" +name = "AddChildNode" +sig = "void AddChildNode(List nodePath)" +returns = "void" +file = "FExTreeViewNode.cs" + +[[methods]] +parent = "FExTreeViewNode" +name = "AddChildNode" +sig = "void AddChildNode(List nodePath, string name, bool unique, string iconPath, bool isIconAttachedToFile, bool isExpanded)" +returns = "void" +file = "FExTreeViewNode.cs" + +[[methods]] +parent = "FExTreeViewNode" +name = "AddChildNodes" +sig = "void AddChildNodes(IEnumerable nodes)" +returns = "void" +file = "FExTreeViewNode.cs" + +[[methods]] +parent = "FExTreeViewNode" +name = "AddChildNodes" +sig = "void AddChildNodes(IEnumerable nodes, bool unique)" +returns = "void" +file = "FExTreeViewNode.cs" + +[[methods]] +parent = "FExTreeViewNode" +name = "Equals" +sig = "bool Equals(FExTreeViewNode other)" +returns = "bool" +file = "FExTreeViewNode.cs" + +[[methods]] +parent = "FExTreeViewNode" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +file = "FExTreeViewNode.cs" + +[[methods]] +parent = "FExTreeViewNode" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +file = "FExTreeViewNode.cs" + [[classes]] name = "LinkableNotifyPropertyChanged" ns = "FEx.MVVM.Abstractions" base = "NotifyPropertyChanged, ILinkableNotifyPropertyChanged" file = "LinkableNotifyPropertyChanged.cs" +[[ctors]] +parent = "LinkableNotifyPropertyChanged" +sig = "LinkableNotifyPropertyChanged()" +file = "LinkableNotifyPropertyChanged.cs" + +[[methods]] +parent = "LinkableNotifyPropertyChanged" +name = "OnPropertySet" +sig = "void OnPropertySet(T oldValue, T newValue, string propertyName)" +returns = "void" +file = "LinkableNotifyPropertyChanged.cs" + +[[methods]] +parent = "LinkableNotifyPropertyChanged" +name = "AddLink" +sig = "void AddLink(ILink link)" +returns = "void" +file = "LinkableNotifyPropertyChanged.cs" + +[[methods]] +parent = "LinkableNotifyPropertyChanged" +name = "Unlink" +sig = "void Unlink(ILink link, bool resetProperty)" +returns = "void" +file = "LinkableNotifyPropertyChanged.cs" + +[[methods]] +parent = "LinkableNotifyPropertyChanged" +name = "Unlink" +sig = "void Unlink(Guid linkId, string propertyName, Type propertyType, bool resetProperty)" +returns = "void" +file = "LinkableNotifyPropertyChanged.cs" + [[classes]] name = "LinkManager" ns = "FEx.MVVM.Abstractions" file = "LinkManager.cs" +[[properties]] +parent = "LinkManager" +name = "Links" +sig = "ConcurrentDictionary> Links { get; }" +returns = "ConcurrentDictionary>" +file = "LinkManager.cs" + +[[ctors]] +parent = "LinkManager" +sig = "LinkManager(Func ownerTypeProvider)" +file = "LinkManager.cs" + +[[methods]] +parent = "LinkManager" +name = "OnPropertySet" +sig = "void OnPropertySet(T oldValue, T newValue, string propertyName)" +returns = "void" +file = "LinkManager.cs" + +[[methods]] +parent = "LinkManager" +name = "AddLink" +sig = "void AddLink(ILink link)" +returns = "void" +file = "LinkManager.cs" + +[[methods]] +parent = "LinkManager" +name = "Unlink" +sig = "void Unlink(ILink link, bool resetProperty)" +returns = "void" +file = "LinkManager.cs" + +[[methods]] +parent = "LinkManager" +name = "Unlink" +sig = "void Unlink(Guid linkId, string propertyName, Type propertyType, bool resetProperty)" +returns = "void" +file = "LinkManager.cs" + [[classes]] name = "WidthAndHeight" ns = "FEx.MVVM.Abstractions" base = "IComparable, IEquatable" file = "WidthAndHeight.cs" +[[properties]] +parent = "WidthAndHeight" +name = "Default" +sig = "static WidthAndHeight Default { get; }" +returns = "WidthAndHeight" +file = "WidthAndHeight.cs" +static = true + +[[properties]] +parent = "WidthAndHeight" +name = "Width" +sig = "int Width { get; }" +returns = "int" +file = "WidthAndHeight.cs" + +[[properties]] +parent = "WidthAndHeight" +name = "Height" +sig = "int Height { get; }" +returns = "int" +file = "WidthAndHeight.cs" + +[[ctors]] +parent = "WidthAndHeight" +sig = "WidthAndHeight(int width, int height)" +file = "WidthAndHeight.cs" + +[[methods]] +parent = "WidthAndHeight" +name = "CompareTo" +sig = "int CompareTo(WidthAndHeight other)" +returns = "int" +file = "WidthAndHeight.cs" + +[[methods]] +parent = "WidthAndHeight" +name = "Equals" +sig = "bool Equals(WidthAndHeight other)" +returns = "bool" +file = "WidthAndHeight.cs" + +[[methods]] +parent = "WidthAndHeight" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +file = "WidthAndHeight.cs" + +[[methods]] +parent = "WidthAndHeight" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +file = "WidthAndHeight.cs" + [[classes]] name = "DialogOptionsBase" ns = "FEx.MVVM.Abstractions.Dialogs" file = "Dialogs\\DialogOptionsBase.cs" +[[properties]] +parent = "DialogOptionsBase" +name = "Dialog" +sig = "TDialog Dialog { get; set; }" +returns = "TDialog" +file = "Dialogs\\DialogOptionsBase.cs" + +[[methods]] +parent = "DialogOptionsBase" +name = "MapToDialog" +sig = "TDialog MapToDialog()" +returns = "TDialog" +file = "Dialogs\\DialogOptionsBase.cs" + +[[methods]] +parent = "DialogOptionsBase" +name = "MapFromDialog" +sig = "void MapFromDialog(TDialog dialog)" +returns = "void" +file = "Dialogs\\DialogOptionsBase.cs" + +[[methods]] +parent = "DialogOptionsBase" +name = "ShowDialog" +sig = "T ShowDialog(Func dialogFunc, IProgressAggregator viewModel)" +returns = "T" +file = "Dialogs\\DialogOptionsBase.cs" + [[classes]] name = "FileDialogOptionsBase" ns = "FEx.MVVM.Abstractions.Dialogs" base = "DialogOptionsBase" file = "Dialogs\\FileDialogOptionsBase.cs" +[[properties]] +parent = "FileDialogOptionsBase" +name = "Title" +sig = "string Title { get; set; }" +returns = "string" +summary = "Gets or sets the file dialog box title." +file = "Dialogs\\FileDialogOptionsBase.cs" + +[[properties]] +parent = "FileDialogOptionsBase" +name = "Filter" +sig = "string Filter { get; set; }" +returns = "string" +summary = "Gets or sets the current file name filter string, which determines the choices that appear in the \"Save as file type\" or \"Files of type\" box in the dialog box." +file = "Dialogs\\FileDialogOptionsBase.cs" + +[[properties]] +parent = "FileDialogOptionsBase" +name = "FileName" +sig = "string FileName { get; set; }" +returns = "string" +summary = "Gets or sets a string containing the file name selected in the file dialog box." +file = "Dialogs\\FileDialogOptionsBase.cs" + +[[properties]] +parent = "FileDialogOptionsBase" +name = "RestoreDirectory" +sig = "bool RestoreDirectory { get; set; }" +returns = "bool" +summary = "Gets or sets a value indicating whether the dialog box restores the directory to the previously selected directory before closing." +file = "Dialogs\\FileDialogOptionsBase.cs" + +[[properties]] +parent = "FileDialogOptionsBase" +name = "InitialDirectory" +sig = "string InitialDirectory { get; set; }" +returns = "string" +summary = "Gets or sets the initial directory displayed by the file dialog box." +file = "Dialogs\\FileDialogOptionsBase.cs" + +[[properties]] +parent = "FileDialogOptionsBase" +name = "DefaultExt" +sig = "string DefaultExt { get; set; }" +returns = "string" +summary = "Gets or sets the default file name extension." +file = "Dialogs\\FileDialogOptionsBase.cs" + +[[properties]] +parent = "FileDialogOptionsBase" +name = "FilterIndex" +sig = "int FilterIndex { get; set; }" +returns = "int" +summary = "Gets or sets the index of the filter currently selected in the file dialog box." +file = "Dialogs\\FileDialogOptionsBase.cs" + +[[properties]] +parent = "FileDialogOptionsBase" +name = "CheckFileExists" +sig = "bool CheckFileExists { get; set; }" +returns = "bool" +summary = "Gets or sets a value indicating whether [check file exists]." +file = "Dialogs\\FileDialogOptionsBase.cs" + +[[properties]] +parent = "FileDialogOptionsBase" +name = "CheckPathExists" +sig = "bool CheckPathExists { get; set; }" +returns = "bool" +summary = "Gets or sets a value indicating whether [check path exists]." +file = "Dialogs\\FileDialogOptionsBase.cs" + +[[properties]] +parent = "FileDialogOptionsBase" +name = "FileNames" +sig = "string[] FileNames { get; set; }" +returns = "string[]" +summary = "Gets an array that contains one file name for each selected file." +file = "Dialogs\\FileDialogOptionsBase.cs" + +[[ctors]] +parent = "FileDialogOptionsBase" +sig = "FileDialogOptionsBase()" +file = "Dialogs\\FileDialogOptionsBase.cs" + [[classes]] name = "FolderBrowserDialogOptionsBase" ns = "FEx.MVVM.Abstractions.Dialogs" base = "DialogOptionsBase" file = "Dialogs\\FolderBrowserDialogOptionsBase.cs" +[[properties]] +parent = "FolderBrowserDialogOptionsBase" +name = "Description" +sig = "string Description { get; set; }" +returns = "string" +summary = "Gets or sets the descriptive text displayed above the tree view control in the dialog box." +file = "Dialogs\\FolderBrowserDialogOptionsBase.cs" + +[[properties]] +parent = "FolderBrowserDialogOptionsBase" +name = "SelectedPath" +sig = "string SelectedPath { get; set; }" +returns = "string" +summary = "Gets or sets the initial directory displayed by the file dialog box." +file = "Dialogs\\FolderBrowserDialogOptionsBase.cs" + +[[properties]] +parent = "FolderBrowserDialogOptionsBase" +name = "ShowNewFolderButton" +sig = "bool ShowNewFolderButton { get; set; }" +returns = "bool" +summary = "Gets or sets the default file name extension." +file = "Dialogs\\FolderBrowserDialogOptionsBase.cs" + +[[properties]] +parent = "FolderBrowserDialogOptionsBase" +name = "RootFolder" +sig = "Environment.SpecialFolder RootFolder { get; set; }" +returns = "Environment.SpecialFolder" +file = "Dialogs\\FolderBrowserDialogOptionsBase.cs" + +[[ctors]] +parent = "FolderBrowserDialogOptionsBase" +sig = "FolderBrowserDialogOptionsBase()" +summary = "Initializes a new instance of the class." +file = "Dialogs\\FolderBrowserDialogOptionsBase.cs" + [[classes]] name = "OpenFileDialogOptionsBase" ns = "FEx.MVVM.Abstractions.Dialogs" base = "FileDialogOptionsBase" file = "Dialogs\\OpenFileDialogOptionsBase.cs" +[[properties]] +parent = "OpenFileDialogOptionsBase" +name = "Multiselect" +sig = "bool Multiselect { get; set; }" +returns = "bool" +summary = "Gets or sets an option indicating whether allows users to select multiple files." +file = "Dialogs\\OpenFileDialogOptionsBase.cs" + [[classes]] name = "SaveFileDialogOptionsBase" ns = "FEx.MVVM.Abstractions.Dialogs" @@ -98,6 +612,34 @@ ns = "FEx.MVVM.Abstractions.Events" base = "EventArgs" file = "Events\\ProgressPropertyChangedEventArgs.cs" +[[properties]] +parent = "ProgressPropertyChangedEventArgs" +name = "ContainerId" +sig = "string ContainerId { get; }" +returns = "string" +file = "Events\\ProgressPropertyChangedEventArgs.cs" + +[[properties]] +parent = "ProgressPropertyChangedEventArgs" +name = "PropertyName" +sig = "string PropertyName { get; }" +returns = "string" +summary = "Indicates the name of the property that changed." +file = "Events\\ProgressPropertyChangedEventArgs.cs" + +[[properties]] +parent = "ProgressPropertyChangedEventArgs" +name = "Value" +sig = "object Value { get; }" +returns = "object" +summary = "Contains the value of the property that changed." +file = "Events\\ProgressPropertyChangedEventArgs.cs" + +[[ctors]] +parent = "ProgressPropertyChangedEventArgs" +sig = "ProgressPropertyChangedEventArgs(string containerId, string propertyName, object value)" +file = "Events\\ProgressPropertyChangedEventArgs.cs" + [[classes]] name = "FExTimerExtensions" ns = "FEx.MVVM.Abstractions.Extensions" @@ -106,8 +648,8 @@ static = true [[extensions]] name = "WithAsyncCallback" -sig = "IFExTimer WithAsyncCallback(this IFExTimer timer, Func asyncCallback)" returns = "IFExTimer" +sig = "IFExTimer WithAsyncCallback(this IFExTimer timer, Func asyncCallback)" file = "Extensions\\FExTimerExtensions.cs" [[classes]] @@ -118,17 +660,14 @@ static = true [[extensions]] name = "Unlink" -sig = "void Unlink(this ILinkableNotifyPropertyChanged source, ILink link)" returns = "void" +sig = "void Unlink(this ILinkableNotifyPropertyChanged source, ILink link)" file = "Extensions\\LinkableNotifyPropertyChangedExtensions.cs" [[extensions]] name = "Unlink" -sig = "void Unlink(this ILinkableNotifyPropertyChanged source, - Guid linkId, - string propertyName, - Type propertyType)" returns = "void" +sig = "void Unlink(this ILinkableNotifyPropertyChanged source, Guid linkId, string propertyName, Type propertyType)" file = "Extensions\\LinkableNotifyPropertyChangedExtensions.cs" [[classes]] @@ -139,64 +678,50 @@ static = true [[extensions]] name = "ShowMessageAsync" -sig = "Task ShowMessageAsync(this IMessagePopupService service, string txt)" returns = "Task" +sig = "Task ShowMessageAsync(this IMessagePopupService service, string txt)" file = "Extensions\\MessagePopupServiceExtensions.cs" [[extensions]] name = "ShowMessageAsync" -sig = "Task ShowMessageAsync(this IMessagePopupService service, string txt, string caption)" returns = "Task" +sig = "Task ShowMessageAsync(this IMessagePopupService service, string txt, string caption)" file = "Extensions\\MessagePopupServiceExtensions.cs" [[extensions]] name = "ShowMessageAsync" -sig = "Task ShowMessageAsync(this IMessagePopupService service, - string txt, - string caption, - MessageIcon messageBoxImage)" returns = "Task" +sig = "Task ShowMessageAsync(this IMessagePopupService service, string txt, string caption, MessageIcon messageBoxImage)" file = "Extensions\\MessagePopupServiceExtensions.cs" [[extensions]] name = "ShowMessageAsync" -sig = "Task ShowMessageAsync(this IMessagePopupService service, - string txt, - string caption, - MessageIcon messageBoxImage, - FExMessageButton button)" returns = "Task" +sig = "Task ShowMessageAsync(this IMessagePopupService service, string txt, string caption, MessageIcon messageBoxImage, FExMessageButton button)" file = "Extensions\\MessagePopupServiceExtensions.cs" [[extensions]] name = "ShowMessage" -sig = "MessageResult ShowMessage(this IMessagePopupService service, string txt)" returns = "MessageResult" +sig = "MessageResult ShowMessage(this IMessagePopupService service, string txt)" file = "Extensions\\MessagePopupServiceExtensions.cs" [[extensions]] name = "ShowMessage" -sig = "MessageResult ShowMessage(this IMessagePopupService service, string txt, string caption)" returns = "MessageResult" +sig = "MessageResult ShowMessage(this IMessagePopupService service, string txt, string caption)" file = "Extensions\\MessagePopupServiceExtensions.cs" [[extensions]] name = "ShowMessage" -sig = "MessageResult ShowMessage(this IMessagePopupService service, - string txt, - string caption, - MessageIcon messageBoxImage)" returns = "MessageResult" +sig = "MessageResult ShowMessage(this IMessagePopupService service, string txt, string caption, MessageIcon messageBoxImage)" file = "Extensions\\MessagePopupServiceExtensions.cs" [[extensions]] name = "ShowMessage" -sig = "MessageResult ShowMessage(this IMessagePopupService service, - string txt, - string caption, - MessageIcon messageBoxImage, - FExMessageButton button)" returns = "MessageResult" +sig = "MessageResult ShowMessage(this IMessagePopupService service, string txt, string caption, MessageIcon messageBoxImage, FExMessageButton button)" file = "Extensions\\MessagePopupServiceExtensions.cs" [[classes]] @@ -207,35 +732,112 @@ static = true [[extensions]] name = "PrgSet" -sig = "void PrgSet(this IProgressAggregator aggregator, double? value)" returns = "void" +sig = "void PrgSet(this IProgressAggregator aggregator, double? value)" file = "Extensions\\ProgressAggregatorExtensions.cs" [[extensions]] name = "PrgSet" -sig = "void PrgSet(this IProgressAggregator aggregator, double? value, double? maximum)" returns = "void" +sig = "void PrgSet(this IProgressAggregator aggregator, double? value, double? maximum)" file = "Extensions\\ProgressAggregatorExtensions.cs" [[extensions]] name = "PrgAdd" -sig = "void PrgAdd(this IProgressAggregator aggregator)" returns = "void" +sig = "void PrgAdd(this IProgressAggregator aggregator)" file = "Extensions\\ProgressAggregatorExtensions.cs" [[interfaces]] name = "IAsyncCommand" ns = "FEx.MVVM.Abstractions.Interfaces" +base = "ICommand" +file = "Interfaces\\IAsyncCommand.cs" + +[[methods]] +parent = "IAsyncCommand" +name = "ExecuteAsync" +sig = "Task ExecuteAsync()" +returns = "Task" file = "Interfaces\\IAsyncCommand.cs" [[interfaces]] name = "IAsyncCommand" ns = "FEx.MVVM.Abstractions.Interfaces" +base = "ICommand" +file = "Interfaces\\IAsyncCommand.cs" + +[[methods]] +parent = "IAsyncCommand" +name = "ExecuteAsync" +sig = "Task ExecuteAsync(T parameter)" +returns = "Task" file = "Interfaces\\IAsyncCommand.cs" [[interfaces]] name = "IFExTimer" ns = "FEx.MVVM.Abstractions.Interfaces" +base = "IFExNotifyPropertyChanged, IDisposable" +file = "Interfaces\\IFExTimer.cs" + +[[properties]] +parent = "IFExTimer" +name = "Interval" +sig = "TimeSpan Interval { get; }" +returns = "TimeSpan" +summary = "The timer interval" +file = "Interfaces\\IFExTimer.cs" + +[[properties]] +parent = "IFExTimer" +name = "IsRunning" +sig = "bool IsRunning { get; }" +returns = "bool" +summary = "Indicates whether this timer is running." +file = "Interfaces\\IFExTimer.cs" + +[[methods]] +parent = "IFExTimer" +name = "WithCallback" +sig = "IFExTimer WithCallback(Action callback)" +returns = "IFExTimer" +file = "Interfaces\\IFExTimer.cs" + +[[methods]] +parent = "IFExTimer" +name = "WithAsyncCallback" +sig = "IFExTimer WithAsyncCallback(Func asyncCallback, CancellationToken cancellationToken)" +returns = "IFExTimer" +file = "Interfaces\\IFExTimer.cs" + +[[methods]] +parent = "IFExTimer" +name = "WithInterval" +sig = "IFExTimer WithInterval(double milliseconds)" +returns = "IFExTimer" +file = "Interfaces\\IFExTimer.cs" + +[[methods]] +parent = "IFExTimer" +name = "WithInterval" +sig = "IFExTimer WithInterval(TimeSpan interval)" +returns = "IFExTimer" +file = "Interfaces\\IFExTimer.cs" + +[[methods]] +parent = "IFExTimer" +name = "Start" +sig = "void Start()" +returns = "void" +summary = "Starts the timer." +file = "Interfaces\\IFExTimer.cs" + +[[methods]] +parent = "IFExTimer" +name = "Stop" +sig = "void Stop()" +returns = "void" +summary = "Stops the timer." file = "Interfaces\\IFExTimer.cs" [[interfaces]] @@ -243,9 +845,115 @@ name = "ILink" ns = "FEx.MVVM.Abstractions.Interfaces" file = "Interfaces\\ILink.cs" +[[properties]] +parent = "ILink" +name = "PropertyName" +sig = "string PropertyName { get; }" +returns = "string" +file = "Interfaces\\ILink.cs" + +[[properties]] +parent = "ILink" +name = "Id" +sig = "Guid Id { get; }" +returns = "Guid" +file = "Interfaces\\ILink.cs" + +[[properties]] +parent = "ILink" +name = "DefaultValue" +sig = "object DefaultValue { get; }" +returns = "object" +file = "Interfaces\\ILink.cs" + +[[properties]] +parent = "ILink" +name = "PropertyType" +sig = "Type PropertyType { get; }" +returns = "Type" +file = "Interfaces\\ILink.cs" + +[[methods]] +parent = "ILink" +name = "Unlink" +sig = "void Unlink(bool resetPropertyValue)" +returns = "void" +file = "Interfaces\\ILink.cs" + +[[methods]] +parent = "ILink" +name = "UnlinkChildren" +sig = "void UnlinkChildren(bool resetPropertyValue)" +returns = "void" +file = "Interfaces\\ILink.cs" + +[[methods]] +parent = "ILink" +name = "ResetProperty" +sig = "void ResetProperty()" +returns = "void" +file = "Interfaces\\ILink.cs" + +[[methods]] +parent = "ILink" +name = "GetPropertyValue" +sig = "object GetPropertyValue()" +returns = "object" +file = "Interfaces\\ILink.cs" + +[[methods]] +parent = "ILink" +name = "OnPropertyChange" +sig = "void OnPropertyChange(object oldValue, object newValue)" +returns = "void" +file = "Interfaces\\ILink.cs" + +[[methods]] +parent = "ILink" +name = "Initialize" +sig = "void Initialize()" +returns = "void" +file = "Interfaces\\ILink.cs" + +[[methods]] +parent = "ILink" +name = "AddChild" +sig = "void AddChild(ILink link)" +returns = "void" +file = "Interfaces\\ILink.cs" + +[[methods]] +parent = "ILink" +name = "RelinkChildren" +sig = "void RelinkChildren(T newSender, Action onNewSender) where T : ILinkableNotifyPropertyChanged" +returns = "void" +file = "Interfaces\\ILink.cs" + [[interfaces]] name = "ILinkableNotifyPropertyChanged" ns = "FEx.MVVM.Abstractions.Interfaces" +base = "IFExNotifyPropertyChanged" +file = "Interfaces\\ILinkableNotifyPropertyChanged.cs" + +[[methods]] +parent = "ILinkableNotifyPropertyChanged" +name = "AddLink" +sig = "void AddLink(ILink link)" +returns = "void" +file = "Interfaces\\ILinkableNotifyPropertyChanged.cs" + +[[methods]] +parent = "ILinkableNotifyPropertyChanged" +name = "Unlink" +sig = "void Unlink(ILink link, bool resetProperty)" +returns = "void" +file = "Interfaces\\ILinkableNotifyPropertyChanged.cs" + +[[methods]] +parent = "ILinkableNotifyPropertyChanged" +name = "Unlink" +sig = "void Unlink(Guid linkId, string propertyName, Type propertyType, bool resetProperty)" +returns = "void" file = "Interfaces\\ILinkableNotifyPropertyChanged.cs" [[interfaces]] @@ -253,9 +961,120 @@ name = "IMessagePopupService" ns = "FEx.MVVM.Abstractions.Interfaces" file = "Interfaces\\IMessagePopupService.cs" +[[properties]] +parent = "IMessagePopupService" +name = "AppIsClosing" +sig = "bool AppIsClosing { get; set; }" +returns = "bool" +file = "Interfaces\\IMessagePopupService.cs" + +[[methods]] +parent = "IMessagePopupService" +name = "ShowMessageAsync" +sig = "Task ShowMessageAsync(string txt, string caption, MessageIcon messageBoxImage, FExMessageButton button, ISupportInitialize ownerWindow, bool informUser, bool wait, Stopwatch sw, LogLevel level, Exception exception)" +returns = "Task" +file = "Interfaces\\IMessagePopupService.cs" + +[[methods]] +parent = "IMessagePopupService" +name = "ShowMessage" +sig = "MessageResult ShowMessage(string txt, string caption, MessageIcon messageBoxImage, FExMessageButton button, ISupportInitialize ownerWindow, bool informUser, bool wait, Stopwatch sw, LogLevel level, Exception exception)" +returns = "MessageResult" +file = "Interfaces\\IMessagePopupService.cs" + [[interfaces]] name = "IProgressAggregator" ns = "FEx.MVVM.Abstractions.Interfaces" +base = "IProgressStatus, IDisposable" +file = "Interfaces\\IProgressAggregator.cs" + +[[properties]] +parent = "IProgressAggregator" +name = "Stopwatch" +sig = "Stopwatch Stopwatch { get; }" +returns = "Stopwatch" +file = "Interfaces\\IProgressAggregator.cs" + +[[properties]] +parent = "IProgressAggregator" +name = "Timer" +sig = "IFExTimer Timer { get; }" +returns = "IFExTimer" +file = "Interfaces\\IProgressAggregator.cs" + +[[properties]] +parent = "IProgressAggregator" +name = "Id" +sig = "string Id { get; }" +returns = "string" +file = "Interfaces\\IProgressAggregator.cs" + +[[methods]] +parent = "IProgressAggregator" +name = "Start" +sig = "void Start()" +returns = "void" +file = "Interfaces\\IProgressAggregator.cs" + +[[methods]] +parent = "IProgressAggregator" +name = "Stop" +sig = "void Stop()" +returns = "void" +file = "Interfaces\\IProgressAggregator.cs" + +[[methods]] +parent = "IProgressAggregator" +name = "PrgSet" +sig = "void PrgSet(double? value, double? maximum, ProgressChangeMode mode)" +returns = "void" +summary = "Sets current progress value and maximal allowed value of the ProgressBar" +file = "Interfaces\\IProgressAggregator.cs" + +[[methods]] +parent = "IProgressAggregator" +name = "PrgSetEnd" +sig = "void PrgSetEnd()" +returns = "void" +summary = "Sets progress value of the ProgressBar to the maximal value" +file = "Interfaces\\IProgressAggregator.cs" + +[[methods]] +parent = "IProgressAggregator" +name = "PrgAdd" +sig = "void PrgAdd(double addedValue)" +returns = "void" +summary = "Increments current progress value of the ProgressBar" +file = "Interfaces\\IProgressAggregator.cs" + +[[methods]] +parent = "IProgressAggregator" +name = "PrgMaxAdd" +sig = "void PrgMaxAdd(double addedValue)" +returns = "void" +summary = "Adds value to the maximum of progress value." +file = "Interfaces\\IProgressAggregator.cs" + +[[methods]] +parent = "IProgressAggregator" +name = "PrgSetMax" +sig = "void PrgSetMax(double max)" +returns = "void" +summary = "Sets maximal allowed value of the ProgressBar and resets current progress" +file = "Interfaces\\IProgressAggregator.cs" + +[[methods]] +parent = "IProgressAggregator" +name = "Report" +sig = "void Report(string propertyName, object value)" +returns = "void" +file = "Interfaces\\IProgressAggregator.cs" + +[[methods]] +parent = "IProgressAggregator" +name = "GetProperties" +sig = "List GetProperties()" +returns = "List" file = "Interfaces\\IProgressAggregator.cs" [[interfaces]] @@ -266,10 +1085,243 @@ file = "Interfaces\\IProgressNotifyPropertyChanged.cs" [[interfaces]] name = "IProgressStatus" ns = "FEx.MVVM.Abstractions.Interfaces" +base = "ILinkableNotifyPropertyChanged" +file = "Interfaces\\IProgressStatus.cs" + +[[properties]] +parent = "IProgressStatus" +name = "Value" +sig = "double Value { get; }" +returns = "double" +file = "Interfaces\\IProgressStatus.cs" + +[[properties]] +parent = "IProgressStatus" +name = "Maximum" +sig = "double Maximum { get; }" +returns = "double" +file = "Interfaces\\IProgressStatus.cs" + +[[properties]] +parent = "IProgressStatus" +name = "IsIndeterminate" +sig = "bool IsIndeterminate { get; }" +returns = "bool" +file = "Interfaces\\IProgressStatus.cs" + +[[properties]] +parent = "IProgressStatus" +name = "Percentage" +sig = "double Percentage { get; }" +returns = "double" +file = "Interfaces\\IProgressStatus.cs" + +[[properties]] +parent = "IProgressStatus" +name = "PrecisePercentage" +sig = "double PrecisePercentage { get; }" +returns = "double" +file = "Interfaces\\IProgressStatus.cs" + +[[properties]] +parent = "IProgressStatus" +name = "Info" +sig = "string Info { get; }" +returns = "string" +file = "Interfaces\\IProgressStatus.cs" + +[[properties]] +parent = "IProgressStatus" +name = "Unit" +sig = "string Unit { get; }" +returns = "string" +file = "Interfaces\\IProgressStatus.cs" + +[[properties]] +parent = "IProgressStatus" +name = "Mode" +sig = "ProgressOperationMode Mode { get; }" +returns = "ProgressOperationMode" +file = "Interfaces\\IProgressStatus.cs" + +[[properties]] +parent = "IProgressStatus" +name = "State" +sig = "ProgressState State { get; }" +returns = "ProgressState" +file = "Interfaces\\IProgressStatus.cs" + +[[properties]] +parent = "IProgressStatus" +name = "IsBusy" +sig = "bool IsBusy { get; }" +returns = "bool" +file = "Interfaces\\IProgressStatus.cs" + +[[properties]] +parent = "IProgressStatus" +name = "IsInfoVisible" +sig = "bool? IsInfoVisible { get; }" +returns = "bool?" +file = "Interfaces\\IProgressStatus.cs" + +[[properties]] +parent = "IProgressStatus" +name = "StatusInfo" +sig = "string StatusInfo { get; }" +returns = "string" +file = "Interfaces\\IProgressStatus.cs" + +[[properties]] +parent = "IProgressStatus" +name = "CurrItemInfo" +sig = "string CurrItemInfo { get; }" +returns = "string" +file = "Interfaces\\IProgressStatus.cs" + +[[properties]] +parent = "IProgressStatus" +name = "ThreadsInfo" +sig = "string ThreadsInfo { get; }" +returns = "string" +file = "Interfaces\\IProgressStatus.cs" + +[[methods]] +parent = "IProgressStatus" +name = "SetValue" +sig = "void SetValue(double value)" +returns = "void" +file = "Interfaces\\IProgressStatus.cs" + +[[methods]] +parent = "IProgressStatus" +name = "SetMaximum" +sig = "void SetMaximum(double value)" +returns = "void" +file = "Interfaces\\IProgressStatus.cs" + +[[methods]] +parent = "IProgressStatus" +name = "SetIsIndeterminate" +sig = "void SetIsIndeterminate(bool value)" +returns = "void" +file = "Interfaces\\IProgressStatus.cs" + +[[methods]] +parent = "IProgressStatus" +name = "SetPrecisePercentage" +sig = "void SetPrecisePercentage(double value)" +returns = "void" +file = "Interfaces\\IProgressStatus.cs" + +[[methods]] +parent = "IProgressStatus" +name = "SetInfo" +sig = "void SetInfo(string value)" +returns = "void" +file = "Interfaces\\IProgressStatus.cs" + +[[methods]] +parent = "IProgressStatus" +name = "SetUnit" +sig = "void SetUnit(string value)" +returns = "void" +file = "Interfaces\\IProgressStatus.cs" + +[[methods]] +parent = "IProgressStatus" +name = "SetMode" +sig = "void SetMode(ProgressOperationMode value)" +returns = "void" +file = "Interfaces\\IProgressStatus.cs" + +[[methods]] +parent = "IProgressStatus" +name = "SetIsFileOperation" +sig = "void SetIsFileOperation(bool value)" +returns = "void" +file = "Interfaces\\IProgressStatus.cs" + +[[methods]] +parent = "IProgressStatus" +name = "SetState" +sig = "void SetState(ProgressState value)" +returns = "void" +file = "Interfaces\\IProgressStatus.cs" + +[[methods]] +parent = "IProgressStatus" +name = "SetIsBusy" +sig = "void SetIsBusy(bool value)" +returns = "void" +file = "Interfaces\\IProgressStatus.cs" + +[[methods]] +parent = "IProgressStatus" +name = "Busy" +sig = "void Busy()" +returns = "void" +file = "Interfaces\\IProgressStatus.cs" + +[[methods]] +parent = "IProgressStatus" +name = "Idle" +sig = "void Idle()" +returns = "void" +file = "Interfaces\\IProgressStatus.cs" + +[[methods]] +parent = "IProgressStatus" +name = "SetIsInfoVisible" +sig = "void SetIsInfoVisible(bool? value)" +returns = "void" +file = "Interfaces\\IProgressStatus.cs" + +[[methods]] +parent = "IProgressStatus" +name = "SetStatusInfo" +sig = "void SetStatusInfo(string value)" +returns = "void" +file = "Interfaces\\IProgressStatus.cs" + +[[methods]] +parent = "IProgressStatus" +name = "SetCurrItemInfo" +sig = "void SetCurrItemInfo(string value)" +returns = "void" +file = "Interfaces\\IProgressStatus.cs" + +[[methods]] +parent = "IProgressStatus" +name = "SetThreadsInfo" +sig = "void SetThreadsInfo(string value)" +returns = "void" file = "Interfaces\\IProgressStatus.cs" [[interfaces]] name = "IViewModelBase" ns = "FEx.MVVM.Abstractions.Interfaces" +base = "IEquatable" +file = "Interfaces\\IViewModelBase.cs" + +[[properties]] +parent = "IViewModelBase" +name = "Id" +sig = "string Id { get; }" +returns = "string" +file = "Interfaces\\IViewModelBase.cs" + +[[properties]] +parent = "IViewModelBase" +name = "IsInDesignMode" +sig = "bool IsInDesignMode { get; }" +returns = "bool" +file = "Interfaces\\IViewModelBase.cs" + +[[properties]] +parent = "IViewModelBase" +name = "Title" +sig = "string Title { get; set; }" +returns = "string" file = "Interfaces\\IViewModelBase.cs" diff --git a/.api-surface/FEx/MVVM.Rx.Legacy.toml b/.api-surface/FEx/MVVM.Rx.Legacy.toml index ee0da5b1..1587b818 100644 --- a/.api-surface/FEx/MVVM.Rx.Legacy.toml +++ b/.api-surface/FEx/MVVM.Rx.Legacy.toml @@ -8,34 +8,76 @@ ns = "FEx.MVVM.Rx.Legacy" base = "FExInitializable" file = "FExMVVMRx.cs" +[[properties]] +parent = "FExMvvmRx" +name = "StatusService" +sig = "static IStatusService StatusService { get; }" +returns = "IStatusService" +file = "FExMVVMRx.cs" +static = true + +[[ctors]] +parent = "FExMvvmRx" +sig = "FExMvvmRx(IStatusService statusService)" +file = "FExMVVMRx.cs" + +[[methods]] +parent = "FExMvvmRx" +name = "OnInitialize" +sig = "void OnInitialize()" +returns = "void" +file = "FExMVVMRx.cs" + [[classes]] name = "FExMvvmRxModule" ns = "FEx.MVVM.Rx.Legacy" base = "InitializeModule" file = "FExMVVMRxModule.cs" -[[interfaces]] -name = "IDisposableProgress" -ns = "FEx.MVVM.Rx.Legacy.Abstractions.Interfaces" -summary = "An that is disposable." -file = "Abstractions\\Interfaces\\IDisposableProgress.cs" - -[[interfaces]] -name = "IDisposableProgress" -ns = "FEx.MVVM.Rx.Legacy.Abstractions.Interfaces" -summary = "An that is disposable." -file = "Abstractions\\Interfaces\\IDisposableProgress.cs" - -[[interfaces]] -name = "IFExMvvmRxContainer" -ns = "FEx.MVVM.Rx.Legacy.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IFExMVVMRxContainer.cs" +[[methods]] +parent = "FExMvvmRxModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExMvvmRxContainer container, IServiceCollection services)" +returns = "void" +file = "FExMVVMRxModule.cs" [[classes]] name = "LinkableReactiveNotifyPropertyChanged" ns = "FEx.MVVM.Rx.Legacy.BaseObjects" -base = "ReactiveNotifyPropertyChanged, - ILinkableNotifyPropertyChanged" +base = "ReactiveNotifyPropertyChanged, ILinkableNotifyPropertyChanged" +file = "BaseObjects\\LinkableReactiveNotifyPropertyChanged.cs" + +[[ctors]] +parent = "LinkableReactiveNotifyPropertyChanged" +sig = "LinkableReactiveNotifyPropertyChanged()" +file = "BaseObjects\\LinkableReactiveNotifyPropertyChanged.cs" + +[[methods]] +parent = "LinkableReactiveNotifyPropertyChanged" +name = "OnPropertySet" +sig = "void OnPropertySet(T oldValue, T newValue, string propertyName)" +returns = "void" +file = "BaseObjects\\LinkableReactiveNotifyPropertyChanged.cs" + +[[methods]] +parent = "LinkableReactiveNotifyPropertyChanged" +name = "AddLink" +sig = "void AddLink(ILink link)" +returns = "void" +file = "BaseObjects\\LinkableReactiveNotifyPropertyChanged.cs" + +[[methods]] +parent = "LinkableReactiveNotifyPropertyChanged" +name = "Unlink" +sig = "void Unlink(ILink link, bool resetProperty)" +returns = "void" +file = "BaseObjects\\LinkableReactiveNotifyPropertyChanged.cs" + +[[methods]] +parent = "LinkableReactiveNotifyPropertyChanged" +name = "Unlink" +sig = "void Unlink(Guid linkId, string propertyName, Type propertyType, bool resetProperty)" +returns = "void" file = "BaseObjects\\LinkableReactiveNotifyPropertyChanged.cs" [[classes]] @@ -44,18 +86,122 @@ ns = "FEx.MVVM.Rx.Legacy.BaseObjects" base = "ReactiveObject, IFExNotifyPropertyChanged" file = "BaseObjects\\ReactiveNotifyPropertyChanged.cs" +[[methods]] +parent = "ReactiveNotifyPropertyChanged" +name = "OnPropertiesChanged" +sig = "void OnPropertiesChanged(params string[] propertyNames)" +returns = "void" +summary = "Use this method in your ReactiveObject classes when creating custom properties where raiseAndSetIfChanged doesn't suffice." +file = "BaseObjects\\ReactiveNotifyPropertyChanged.cs" + +[[methods]] +parent = "ReactiveNotifyPropertyChanged" +name = "OnPropertyChanged" +sig = "void OnPropertyChanged([CallerMemberName] string propertyName = null)" +returns = "void" +summary = "Use this method in your ReactiveObject classes when creating custom properties where raiseAndSetIfChanged doesn't suffice." +file = "BaseObjects\\ReactiveNotifyPropertyChanged.cs" + +[[methods]] +parent = "ReactiveNotifyPropertyChanged" +name = "SetProperty" +sig = "bool SetProperty(ref TRet backingField, TRet newValue, Action onPropertyChanged, [CallerMemberName] string propertyName = null)" +returns = "bool" +file = "BaseObjects\\ReactiveNotifyPropertyChanged.cs" + +[[methods]] +parent = "ReactiveNotifyPropertyChanged" +name = "OnPropertySet" +sig = "void OnPropertySet(T oldValue, T newValue, string propertyName)" +returns = "void" +file = "BaseObjects\\ReactiveNotifyPropertyChanged.cs" + +[[methods]] +parent = "ReactiveNotifyPropertyChanged" +name = "SetProperty" +sig = "bool SetProperty(ref TRet backingField, TRet newValue, [CallerMemberName] string propertyName = null)" +returns = "bool" +file = "BaseObjects\\ReactiveNotifyPropertyChanged.cs" + [[classes]] name = "ViewModelBase" ns = "FEx.MVVM.Rx.Legacy.BaseObjects" base = "LinkableReactiveNotifyPropertyChanged, IViewModelBase, IEquatable" file = "BaseObjects\\ViewModelBase.cs" +[[properties]] +parent = "ViewModelBase" +name = "Id" +sig = "string Id { get; }" +returns = "string" +file = "BaseObjects\\ViewModelBase.cs" + +[[properties]] +parent = "ViewModelBase" +name = "IsInDesignMode" +sig = "bool IsInDesignMode { get; set; }" +returns = "bool" +file = "BaseObjects\\ViewModelBase.cs" + +[[properties]] +parent = "ViewModelBase" +name = "Title" +sig = "string Title { get; set; }" +returns = "string" +file = "BaseObjects\\ViewModelBase.cs" + +[[ctors]] +parent = "ViewModelBase" +sig = "ViewModelBase()" +file = "BaseObjects\\ViewModelBase.cs" + +[[methods]] +parent = "ViewModelBase" +name = "Equals" +sig = "bool Equals(IViewModelBase other)" +returns = "bool" +file = "BaseObjects\\ViewModelBase.cs" + +[[methods]] +parent = "ViewModelBase" +name = "Equals" +sig = "bool Equals(ViewModelBase other)" +returns = "bool" +file = "BaseObjects\\ViewModelBase.cs" + +[[methods]] +parent = "ViewModelBase" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +file = "BaseObjects\\ViewModelBase.cs" + +[[methods]] +parent = "ViewModelBase" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +file = "BaseObjects\\ViewModelBase.cs" + +[[methods]] +parent = "ViewModelBase" +name = "GetIsInDesignMode" +sig = "bool GetIsInDesignMode()" +returns = "bool" +file = "BaseObjects\\ViewModelBase.cs" + [[classes]] name = "ReactiveObjectExtensions" ns = "FEx.MVVM.Rx.Legacy.Extensions" file = "Extensions\\ReactiveObjectExtensions.cs" static = true +[[extensions]] +name = "SetProperty" +returns = "bool" +sig = "bool SetProperty(this TObj sender, ref TRet backingField, TRet newValue, [CallerMemberName] string propertyName = null)" +file = "Extensions\\ReactiveObjectExtensions.cs" + [[classes]] name = "ObservableProgress" ns = "FEx.MVVM.Rx.Legacy.Utilities" @@ -63,15 +209,340 @@ base = "IObservable, IDisposableProgress" summary = "A progress reporter that exposes progress updates as an observable stream. This is a hot observable." file = "Utilities\\ObservableProgress.cs" +[[properties]] +parent = "ObservableProgress" +name = "IsDisposed" +sig = "bool IsDisposed { get; }" +returns = "bool" +file = "Utilities\\ObservableProgress.cs" + +[[ctors]] +parent = "ObservableProgress" +sig = "ObservableProgress()" +summary = "Creates an observable progress that uses a replay subject with a single-element buffer, ensuring all new subscriptions immediately receive the last progress update." +file = "Utilities\\ObservableProgress.cs" + +[[ctors]] +parent = "ObservableProgress" +sig = "ObservableProgress(IScheduler scheduler)" +summary = "Creates an observable progress that uses a replay subject with a single-element buffer, ensuring all new subscriptions immediately receive the last progress update." +file = "Utilities\\ObservableProgress.cs" + +[[ctors]] +parent = "ObservableProgress" +sig = "ObservableProgress(ISubject subject)" +summary = "Creates an observable progress that uses the specified subject." +file = "Utilities\\ObservableProgress.cs" + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithBuffer" +sig = "static IDisposableProgress CreateForUiWithBuffer(TimeSpan sampleTimeSpan, Action> handler)" +returns = "IDisposableProgress" +summary = "Creates a progress handler with common UI options: updates are buffered in intervals, and the is executed on the UI thread. This method must be called from the UI thread. The UI should already be initialized with the default state; is not invoked with an initial value." +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithBuffer" +sig = "static IDisposableProgress CreateForUiWithBuffer(TimeSpan sampleTimeSpan, Action> handler, Func, bool> predicate)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithBuffer" +sig = "static IDisposableProgress CreateForUiWithBuffer(TimeSpan sampleTimeSpan, Action> handler, Func, bool> predicate, bool limitToCurrentThread)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "Create" +sig = "static IDisposableProgress Create(Action handler, Func, IObservable> subFunc)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "Create" +sig = "static IDisposableProgress Create(Action handler, Func, IObservable> subFunc, bool limitToCurrentThread)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithSample" +sig = "static IDisposableProgress CreateForUiWithSample(TimeSpan sampleTimeSpan, Action handler)" +returns = "IDisposableProgress" +summary = "Creates a progress handler with common UI options: updates are sampled on intervals, and the is executed on the UI thread. This method must be called from the UI thread. The UI should already be initialized with the default state; is not invoked with an initial value." +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithSample" +sig = "static IDisposableProgress CreateForUiWithSample(TimeSpan sampleTimeSpan, Action handler, IScheduler scheduler)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithSample" +sig = "static IDisposableProgress CreateForUiWithSample(TimeSpan sampleTimeSpan, Action handler, IScheduler scheduler, bool limitToCurrentThread)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithSample" +sig = "static IDisposableProgress CreateForUiWithSample(Action handler)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithSample" +sig = "static IDisposableProgress CreateForUiWithSample(Action handler, bool limitToCurrentThread)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithSample" +sig = "static IDisposableProgress CreateForUiWithSample(Action handler, IScheduler scheduler)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithSample" +sig = "static IDisposableProgress CreateForUiWithSample(Action handler, IScheduler scheduler, bool limitToCurrentThread)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Utilities\\ObservableProgress.cs" + [[classes]] name = "StatusHub" ns = "FEx.MVVM.Rx.Legacy.Utilities" base = "IDisposable, IStatusHub" file = "Utilities\\StatusHub.cs" +[[properties]] +parent = "StatusHub" +name = "Key" +sig = "Guid Key { get; }" +returns = "Guid" +file = "Utilities\\StatusHub.cs" + +[[ctors]] +parent = "StatusHub" +sig = "StatusHub(Guid key)" +file = "Utilities\\StatusHub.cs" + +[[ctors]] +parent = "StatusHub" +sig = "StatusHub(Guid key, Action onStatusAdded, Action onStatusRemoved, Action onStatusesReset)" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "AttachToStatusChanges" +sig = "void AttachToStatusChanges(Action onStatusAdded, Action onStatusRemoved, Action onStatusesReset)" +returns = "void" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "AddStatus" +sig = "Guid AddStatus(string status, bool unique)" +returns = "Guid" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "RemoveStatus" +sig = "void RemoveStatus(Guid key)" +returns = "void" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "CleanStatuses" +sig = "void CleanStatuses()" +returns = "void" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "GetStatuses" +sig = "IList GetStatuses()" +returns = "IList" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "GetStatusString" +sig = "string GetStatusString(string separator)" +returns = "string" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "Log" +sig = "DisposableAction Log(string status, bool unique)" +returns = "DisposableAction" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "AddStatus" +sig = "Guid AddStatus(string status)" +returns = "Guid" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "GetStatusString" +sig = "string GetStatusString()" +returns = "string" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "Log" +sig = "DisposableAction Log(string status)" +returns = "DisposableAction" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Utilities\\StatusHub.cs" + [[classes]] name = "StatusService" ns = "FEx.MVVM.Rx.Legacy.Utilities" base = "IStatusService" file = "Utilities\\StatusService.cs" +[[properties]] +parent = "StatusService" +name = "MainHub" +sig = "IStatusHub MainHub { get; }" +returns = "IStatusHub" +file = "Utilities\\StatusService.cs" + +[[properties]] +parent = "StatusService" +name = "MainHubKey" +sig = "Guid? MainHubKey { get; }" +returns = "Guid?" +file = "Utilities\\StatusService.cs" + +[[ctors]] +parent = "StatusService" +sig = "StatusService()" +file = "Utilities\\StatusService.cs" + +[[methods]] +parent = "StatusService" +name = "GetOrAdd" +sig = "IStatusHub GetOrAdd(Guid? key, Action onStatusAdded, Action onStatusRemoved, Action onStatusesReset, bool markAsMain)" +returns = "IStatusHub" +file = "Utilities\\StatusService.cs" + +[[methods]] +parent = "StatusService" +name = "LogToMainHub" +sig = "Guid LogToMainHub(string status, bool unique)" +returns = "Guid" +file = "Utilities\\StatusService.cs" + +[[methods]] +parent = "StatusService" +name = "RemoveMainLog" +sig = "void RemoveMainLog(Guid statusKey)" +returns = "void" +file = "Utilities\\StatusService.cs" + +[[methods]] +parent = "StatusService" +name = "Log" +sig = "DisposableAction Log(string status, IStatusHub hub, bool unique)" +returns = "DisposableAction" +file = "Utilities\\StatusService.cs" + +[[methods]] +parent = "StatusService" +name = "GetOrAdd" +sig = "IStatusHub GetOrAdd()" +returns = "IStatusHub" +file = "Utilities\\StatusService.cs" + +[[methods]] +parent = "StatusService" +name = "LogToMainHub" +sig = "Guid LogToMainHub(string status)" +returns = "Guid" +file = "Utilities\\StatusService.cs" + +[[methods]] +parent = "StatusService" +name = "Log" +sig = "DisposableAction Log(string status)" +returns = "DisposableAction" +file = "Utilities\\StatusService.cs" + +[[methods]] +parent = "StatusService" +name = "Log" +sig = "DisposableAction Log(string status, IStatusHub hub)" +returns = "DisposableAction" +file = "Utilities\\StatusService.cs" + +[[interfaces]] +name = "IDisposableProgress" +ns = "FEx.MVVM.Rx.Legacy.Abstractions.Interfaces" +base = "IProgress, IDisposableProgress" +summary = "An that is disposable." +file = "Abstractions\\Interfaces\\IDisposableProgress.cs" + +[[interfaces]] +name = "IDisposableProgress" +ns = "FEx.MVVM.Rx.Legacy.Abstractions.Interfaces" +base = "IDisposable" +file = "Abstractions\\Interfaces\\IDisposableProgress.cs" + +[[properties]] +parent = "IDisposableProgress" +name = "IsDisposed" +sig = "bool IsDisposed { get; }" +returns = "bool" +file = "Abstractions\\Interfaces\\IDisposableProgress.cs" + +[[interfaces]] +name = "IFExMvvmRxContainer" +ns = "FEx.MVVM.Rx.Legacy.Abstractions.Interfaces" +base = "IContainer, IContainer" +file = "Abstractions\\Interfaces\\IFExMVVMRxContainer.cs" + diff --git a/.api-surface/FEx/MVVM.Rx.toml b/.api-surface/FEx/MVVM.Rx.toml index bf31f5b8..21b5b32e 100644 --- a/.api-surface/FEx/MVVM.Rx.toml +++ b/.api-surface/FEx/MVVM.Rx.toml @@ -8,34 +8,76 @@ ns = "FEx.MVVM.Rx" base = "FExInitializable" file = "FExMVVMRx.cs" +[[properties]] +parent = "FExMvvmRx" +name = "StatusService" +sig = "static IStatusService StatusService { get; }" +returns = "IStatusService" +file = "FExMVVMRx.cs" +static = true + +[[ctors]] +parent = "FExMvvmRx" +sig = "FExMvvmRx(IStatusService statusService)" +file = "FExMVVMRx.cs" + +[[methods]] +parent = "FExMvvmRx" +name = "OnInitialize" +sig = "void OnInitialize()" +returns = "void" +file = "FExMVVMRx.cs" + [[classes]] name = "FExMvvmRxModule" ns = "FEx.MVVM.Rx" base = "InitializeModule" file = "FExMVVMRxModule.cs" -[[interfaces]] -name = "IDisposableProgress" -ns = "FEx.MVVM.Rx.Abstractions.Interfaces" -summary = "An that is disposable." -file = "Abstractions\\Interfaces\\IDisposableProgress.cs" - -[[interfaces]] -name = "IDisposableProgress" -ns = "FEx.MVVM.Rx.Abstractions.Interfaces" -summary = "An that is disposable." -file = "Abstractions\\Interfaces\\IDisposableProgress.cs" - -[[interfaces]] -name = "IFExMvvmRxContainer" -ns = "FEx.MVVM.Rx.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IFExMVVMRxContainer.cs" +[[methods]] +parent = "FExMvvmRxModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExMvvmRxContainer container, IServiceCollection services)" +returns = "void" +file = "FExMVVMRxModule.cs" [[classes]] name = "LinkableReactiveNotifyPropertyChanged" ns = "FEx.MVVM.Rx.BaseObjects" -base = "ReactiveNotifyPropertyChanged, - ILinkableNotifyPropertyChanged" +base = "ReactiveNotifyPropertyChanged, ILinkableNotifyPropertyChanged" +file = "BaseObjects\\LinkableReactiveNotifyPropertyChanged.cs" + +[[ctors]] +parent = "LinkableReactiveNotifyPropertyChanged" +sig = "LinkableReactiveNotifyPropertyChanged()" +file = "BaseObjects\\LinkableReactiveNotifyPropertyChanged.cs" + +[[methods]] +parent = "LinkableReactiveNotifyPropertyChanged" +name = "OnPropertySet" +sig = "void OnPropertySet(T oldValue, T newValue, string propertyName)" +returns = "void" +file = "BaseObjects\\LinkableReactiveNotifyPropertyChanged.cs" + +[[methods]] +parent = "LinkableReactiveNotifyPropertyChanged" +name = "AddLink" +sig = "void AddLink(ILink link)" +returns = "void" +file = "BaseObjects\\LinkableReactiveNotifyPropertyChanged.cs" + +[[methods]] +parent = "LinkableReactiveNotifyPropertyChanged" +name = "Unlink" +sig = "void Unlink(ILink link, bool resetProperty)" +returns = "void" +file = "BaseObjects\\LinkableReactiveNotifyPropertyChanged.cs" + +[[methods]] +parent = "LinkableReactiveNotifyPropertyChanged" +name = "Unlink" +sig = "void Unlink(Guid linkId, string propertyName, Type propertyType, bool resetProperty)" +returns = "void" file = "BaseObjects\\LinkableReactiveNotifyPropertyChanged.cs" [[classes]] @@ -44,18 +86,122 @@ ns = "FEx.MVVM.Rx.BaseObjects" base = "ReactiveObject, IFExNotifyPropertyChanged" file = "BaseObjects\\ReactiveNotifyPropertyChanged.cs" +[[methods]] +parent = "ReactiveNotifyPropertyChanged" +name = "OnPropertiesChanged" +sig = "void OnPropertiesChanged(params string[] propertyNames)" +returns = "void" +summary = "Use this method in your ReactiveObject classes when creating custom properties where raiseAndSetIfChanged doesn't suffice." +file = "BaseObjects\\ReactiveNotifyPropertyChanged.cs" + +[[methods]] +parent = "ReactiveNotifyPropertyChanged" +name = "OnPropertyChanged" +sig = "void OnPropertyChanged([CallerMemberName] string propertyName = null)" +returns = "void" +summary = "Use this method in your ReactiveObject classes when creating custom properties where raiseAndSetIfChanged doesn't suffice." +file = "BaseObjects\\ReactiveNotifyPropertyChanged.cs" + +[[methods]] +parent = "ReactiveNotifyPropertyChanged" +name = "SetProperty" +sig = "bool SetProperty(ref TRet backingField, TRet newValue, Action onPropertyChanged, [CallerMemberName] string propertyName = null)" +returns = "bool" +file = "BaseObjects\\ReactiveNotifyPropertyChanged.cs" + +[[methods]] +parent = "ReactiveNotifyPropertyChanged" +name = "OnPropertySet" +sig = "void OnPropertySet(T oldValue, T newValue, string propertyName)" +returns = "void" +file = "BaseObjects\\ReactiveNotifyPropertyChanged.cs" + +[[methods]] +parent = "ReactiveNotifyPropertyChanged" +name = "SetProperty" +sig = "bool SetProperty(ref TRet backingField, TRet newValue, [CallerMemberName] string propertyName = null)" +returns = "bool" +file = "BaseObjects\\ReactiveNotifyPropertyChanged.cs" + [[classes]] name = "ViewModelBase" ns = "FEx.MVVM.Rx.BaseObjects" base = "LinkableReactiveNotifyPropertyChanged, IViewModelBase, IEquatable" file = "BaseObjects\\ViewModelBase.cs" +[[properties]] +parent = "ViewModelBase" +name = "Id" +sig = "string Id { get; }" +returns = "string" +file = "BaseObjects\\ViewModelBase.cs" + +[[properties]] +parent = "ViewModelBase" +name = "IsInDesignMode" +sig = "bool IsInDesignMode { get; set; }" +returns = "bool" +file = "BaseObjects\\ViewModelBase.cs" + +[[properties]] +parent = "ViewModelBase" +name = "Title" +sig = "string Title { get; set; }" +returns = "string" +file = "BaseObjects\\ViewModelBase.cs" + +[[ctors]] +parent = "ViewModelBase" +sig = "ViewModelBase()" +file = "BaseObjects\\ViewModelBase.cs" + +[[methods]] +parent = "ViewModelBase" +name = "Equals" +sig = "bool Equals(IViewModelBase other)" +returns = "bool" +file = "BaseObjects\\ViewModelBase.cs" + +[[methods]] +parent = "ViewModelBase" +name = "Equals" +sig = "bool Equals(ViewModelBase other)" +returns = "bool" +file = "BaseObjects\\ViewModelBase.cs" + +[[methods]] +parent = "ViewModelBase" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +file = "BaseObjects\\ViewModelBase.cs" + +[[methods]] +parent = "ViewModelBase" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +file = "BaseObjects\\ViewModelBase.cs" + +[[methods]] +parent = "ViewModelBase" +name = "GetIsInDesignMode" +sig = "bool GetIsInDesignMode()" +returns = "bool" +file = "BaseObjects\\ViewModelBase.cs" + [[classes]] name = "ReactiveObjectExtensions" ns = "FEx.MVVM.Rx.Extensions" file = "Extensions\\ReactiveObjectExtensions.cs" static = true +[[extensions]] +name = "SetProperty" +returns = "bool" +sig = "bool SetProperty(this TObj sender, ref TRet backingField, TRet newValue, [CallerMemberName] string propertyName = null)" +file = "Extensions\\ReactiveObjectExtensions.cs" + [[classes]] name = "ObservableProgress" ns = "FEx.MVVM.Rx.Utilities" @@ -63,15 +209,340 @@ base = "IObservable, IDisposableProgress" summary = "A progress reporter that exposes progress updates as an observable stream. This is a hot observable." file = "Utilities\\ObservableProgress.cs" +[[properties]] +parent = "ObservableProgress" +name = "IsDisposed" +sig = "bool IsDisposed { get; }" +returns = "bool" +file = "Utilities\\ObservableProgress.cs" + +[[ctors]] +parent = "ObservableProgress" +sig = "ObservableProgress()" +summary = "Creates an observable progress that uses a replay subject with a single-element buffer, ensuring all new subscriptions immediately receive the last progress update." +file = "Utilities\\ObservableProgress.cs" + +[[ctors]] +parent = "ObservableProgress" +sig = "ObservableProgress(IScheduler scheduler)" +summary = "Creates an observable progress that uses a replay subject with a single-element buffer, ensuring all new subscriptions immediately receive the last progress update." +file = "Utilities\\ObservableProgress.cs" + +[[ctors]] +parent = "ObservableProgress" +sig = "ObservableProgress(ISubject subject)" +summary = "Creates an observable progress that uses the specified subject." +file = "Utilities\\ObservableProgress.cs" + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithBuffer" +sig = "static IDisposableProgress CreateForUiWithBuffer(TimeSpan sampleTimeSpan, Action> handler)" +returns = "IDisposableProgress" +summary = "Creates a progress handler with common UI options: updates are buffered in intervals, and the is executed on the UI thread. This method must be called from the UI thread. The UI should already be initialized with the default state; is not invoked with an initial value." +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithBuffer" +sig = "static IDisposableProgress CreateForUiWithBuffer(TimeSpan sampleTimeSpan, Action> handler, Func, bool> predicate)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithBuffer" +sig = "static IDisposableProgress CreateForUiWithBuffer(TimeSpan sampleTimeSpan, Action> handler, Func, bool> predicate, bool limitToCurrentThread)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "Create" +sig = "static IDisposableProgress Create(Action handler, Func, IObservable> subFunc)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "Create" +sig = "static IDisposableProgress Create(Action handler, Func, IObservable> subFunc, bool limitToCurrentThread)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithSample" +sig = "static IDisposableProgress CreateForUiWithSample(TimeSpan sampleTimeSpan, Action handler)" +returns = "IDisposableProgress" +summary = "Creates a progress handler with common UI options: updates are sampled on intervals, and the is executed on the UI thread. This method must be called from the UI thread. The UI should already be initialized with the default state; is not invoked with an initial value." +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithSample" +sig = "static IDisposableProgress CreateForUiWithSample(TimeSpan sampleTimeSpan, Action handler, IScheduler scheduler)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithSample" +sig = "static IDisposableProgress CreateForUiWithSample(TimeSpan sampleTimeSpan, Action handler, IScheduler scheduler, bool limitToCurrentThread)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithSample" +sig = "static IDisposableProgress CreateForUiWithSample(Action handler)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithSample" +sig = "static IDisposableProgress CreateForUiWithSample(Action handler, bool limitToCurrentThread)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithSample" +sig = "static IDisposableProgress CreateForUiWithSample(Action handler, IScheduler scheduler)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "CreateForUiWithSample" +sig = "static IDisposableProgress CreateForUiWithSample(Action handler, IScheduler scheduler, bool limitToCurrentThread)" +returns = "IDisposableProgress" +file = "Utilities\\ObservableProgress.cs" +static = true + +[[methods]] +parent = "ObservableProgress" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Utilities\\ObservableProgress.cs" + [[classes]] name = "StatusHub" ns = "FEx.MVVM.Rx.Utilities" base = "IDisposable, IStatusHub" file = "Utilities\\StatusHub.cs" +[[properties]] +parent = "StatusHub" +name = "Key" +sig = "Guid Key { get; }" +returns = "Guid" +file = "Utilities\\StatusHub.cs" + +[[ctors]] +parent = "StatusHub" +sig = "StatusHub(Guid key)" +file = "Utilities\\StatusHub.cs" + +[[ctors]] +parent = "StatusHub" +sig = "StatusHub(Guid key, Action onStatusAdded, Action onStatusRemoved, Action onStatusesReset)" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "AttachToStatusChanges" +sig = "void AttachToStatusChanges(Action onStatusAdded, Action onStatusRemoved, Action onStatusesReset)" +returns = "void" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "AddStatus" +sig = "Guid AddStatus(string status, bool unique)" +returns = "Guid" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "RemoveStatus" +sig = "void RemoveStatus(Guid key)" +returns = "void" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "CleanStatuses" +sig = "void CleanStatuses()" +returns = "void" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "GetStatuses" +sig = "IList GetStatuses()" +returns = "IList" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "GetStatusString" +sig = "string GetStatusString(string separator)" +returns = "string" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "Log" +sig = "DisposableAction Log(string status, bool unique)" +returns = "DisposableAction" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "AddStatus" +sig = "Guid AddStatus(string status)" +returns = "Guid" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "GetStatusString" +sig = "string GetStatusString()" +returns = "string" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "Log" +sig = "DisposableAction Log(string status)" +returns = "DisposableAction" +file = "Utilities\\StatusHub.cs" + +[[methods]] +parent = "StatusHub" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Utilities\\StatusHub.cs" + [[classes]] name = "StatusService" ns = "FEx.MVVM.Rx.Utilities" base = "IStatusService" file = "Utilities\\StatusService.cs" +[[properties]] +parent = "StatusService" +name = "MainHub" +sig = "IStatusHub MainHub { get; }" +returns = "IStatusHub" +file = "Utilities\\StatusService.cs" + +[[properties]] +parent = "StatusService" +name = "MainHubKey" +sig = "Guid? MainHubKey { get; }" +returns = "Guid?" +file = "Utilities\\StatusService.cs" + +[[ctors]] +parent = "StatusService" +sig = "StatusService()" +file = "Utilities\\StatusService.cs" + +[[methods]] +parent = "StatusService" +name = "GetOrAdd" +sig = "IStatusHub GetOrAdd(Guid? key, Action onStatusAdded, Action onStatusRemoved, Action onStatusesReset, bool markAsMain)" +returns = "IStatusHub" +file = "Utilities\\StatusService.cs" + +[[methods]] +parent = "StatusService" +name = "LogToMainHub" +sig = "Guid LogToMainHub(string status, bool unique)" +returns = "Guid" +file = "Utilities\\StatusService.cs" + +[[methods]] +parent = "StatusService" +name = "RemoveMainLog" +sig = "void RemoveMainLog(Guid statusKey)" +returns = "void" +file = "Utilities\\StatusService.cs" + +[[methods]] +parent = "StatusService" +name = "Log" +sig = "DisposableAction Log(string status, IStatusHub hub, bool unique)" +returns = "DisposableAction" +file = "Utilities\\StatusService.cs" + +[[methods]] +parent = "StatusService" +name = "GetOrAdd" +sig = "IStatusHub GetOrAdd()" +returns = "IStatusHub" +file = "Utilities\\StatusService.cs" + +[[methods]] +parent = "StatusService" +name = "LogToMainHub" +sig = "Guid LogToMainHub(string status)" +returns = "Guid" +file = "Utilities\\StatusService.cs" + +[[methods]] +parent = "StatusService" +name = "Log" +sig = "DisposableAction Log(string status)" +returns = "DisposableAction" +file = "Utilities\\StatusService.cs" + +[[methods]] +parent = "StatusService" +name = "Log" +sig = "DisposableAction Log(string status, IStatusHub hub)" +returns = "DisposableAction" +file = "Utilities\\StatusService.cs" + +[[interfaces]] +name = "IDisposableProgress" +ns = "FEx.MVVM.Rx.Abstractions.Interfaces" +base = "IProgress, IDisposableProgress" +summary = "An that is disposable." +file = "Abstractions\\Interfaces\\IDisposableProgress.cs" + +[[interfaces]] +name = "IDisposableProgress" +ns = "FEx.MVVM.Rx.Abstractions.Interfaces" +base = "IDisposable" +file = "Abstractions\\Interfaces\\IDisposableProgress.cs" + +[[properties]] +parent = "IDisposableProgress" +name = "IsDisposed" +sig = "bool IsDisposed { get; }" +returns = "bool" +file = "Abstractions\\Interfaces\\IDisposableProgress.cs" + +[[interfaces]] +name = "IFExMvvmRxContainer" +ns = "FEx.MVVM.Rx.Abstractions.Interfaces" +base = "IContainer, IContainer" +file = "Abstractions\\Interfaces\\IFExMVVMRxContainer.cs" + diff --git a/.api-surface/FEx/MVVM.Tests.toml b/.api-surface/FEx/MVVM.Tests.toml index 66cd6b48..4d64335b 100644 --- a/.api-surface/FEx/MVVM.Tests.toml +++ b/.api-surface/FEx/MVVM.Tests.toml @@ -7,37 +7,202 @@ name = "LinkedPropertiesTests" ns = "FEx.MVVM.Tests" file = "LinkedPropertiesTests.cs" +[[methods]] +parent = "LinkedPropertiesTests" +name = "LinkMemberPropertyTest" +sig = "void LinkMemberPropertyTest()" +returns = "void" +file = "LinkedPropertiesTests.cs" + [[classes]] name = "Child" ns = "FEx.MVVM.Tests" base = "LinkableNotifyPropertyChanged" file = "LinkedPropertiesTests.cs" +[[properties]] +parent = "Child" +name = "Info" +sig = "ChildInfo Info { get; set; }" +returns = "ChildInfo" +file = "LinkedPropertiesTests.cs" + +[[ctors]] +parent = "Child" +sig = "Child()" +file = "LinkedPropertiesTests.cs" + [[classes]] name = "ChildInfo" ns = "FEx.MVVM.Tests" base = "LinkableNotifyPropertyChanged" file = "LinkedPropertiesTests.cs" +[[properties]] +parent = "ChildInfo" +name = "Name" +sig = "string Name { get; set; }" +returns = "string" +file = "LinkedPropertiesTests.cs" + +[[properties]] +parent = "ChildInfo" +name = "Age" +sig = "int Age { get; set; }" +returns = "int" +file = "LinkedPropertiesTests.cs" + [[classes]] name = "SingleParent" ns = "FEx.MVVM.Tests" base = "LinkableNotifyPropertyChanged" file = "LinkedPropertiesTests.cs" +[[properties]] +parent = "SingleParent" +name = "Child" +sig = "Child Child { get; set; }" +returns = "Child" +file = "LinkedPropertiesTests.cs" + +[[properties]] +parent = "SingleParent" +name = "ChildAge" +sig = "int ChildAge { get; }" +returns = "int" +file = "LinkedPropertiesTests.cs" + +[[properties]] +parent = "SingleParent" +name = "ChildName" +sig = "string ChildName { get; }" +returns = "string" +file = "LinkedPropertiesTests.cs" + +[[ctors]] +parent = "SingleParent" +sig = "SingleParent(bool link)" +file = "LinkedPropertiesTests.cs" + +[[methods]] +parent = "SingleParent" +name = "Link" +sig = "static void Link(SingleParent p)" +returns = "void" +file = "LinkedPropertiesTests.cs" +static = true + [[classes]] name = "TestableProgressAggregator" ns = "FEx.MVVM.Tests" base = "ProgressAggregator" file = "ProgressAggregatorTests.cs" +[[properties]] +parent = "TestableProgressAggregator" +name = "LoggedErrors" +sig = "List LoggedErrors { get; }" +returns = "List" +file = "ProgressAggregatorTests.cs" + +[[methods]] +parent = "TestableProgressAggregator" +name = "InvokeUpdateProgressInfo" +sig = "void InvokeUpdateProgressInfo()" +returns = "void" +file = "ProgressAggregatorTests.cs" + +[[methods]] +parent = "TestableProgressAggregator" +name = "LogError" +sig = "void LogError(string message)" +returns = "void" +file = "ProgressAggregatorTests.cs" + [[classes]] name = "ProgressAggregatorTests" ns = "FEx.MVVM.Tests" file = "ProgressAggregatorTests.cs" +[[methods]] +parent = "ProgressAggregatorTests" +name = "ProcessSetPrg_NullValue_WithMaximum_ShouldNotLogError" +sig = "void ProcessSetPrg_NullValue_WithMaximum_ShouldNotLogError()" +returns = "void" +file = "ProgressAggregatorTests.cs" + +[[methods]] +parent = "ProgressAggregatorTests" +name = "ProcessAddPrg_NullValue_WithMaximum_ShouldNotLogError" +sig = "void ProcessAddPrg_NullValue_WithMaximum_ShouldNotLogError()" +returns = "void" +file = "ProgressAggregatorTests.cs" + +[[methods]] +parent = "ProgressAggregatorTests" +name = "ProcessSetPrg_ValueExceedsMaximum_ShouldLogError" +sig = "void ProcessSetPrg_ValueExceedsMaximum_ShouldLogError()" +returns = "void" +file = "ProgressAggregatorTests.cs" + +[[methods]] +parent = "ProgressAggregatorTests" +name = "ProcessAddPrg_ValueExceedsMaximum_ShouldLogError" +sig = "void ProcessAddPrg_ValueExceedsMaximum_ShouldLogError()" +returns = "void" +file = "ProgressAggregatorTests.cs" + +[[methods]] +parent = "ProgressAggregatorTests" +name = "Dispose_ShouldStopTimer" +sig = "void Dispose_ShouldStopTimer()" +returns = "void" +file = "ProgressAggregatorTests.cs" + +[[methods]] +parent = "ProgressAggregatorTests" +name = "Dispose_ShouldStopStopwatch" +sig = "void Dispose_ShouldStopStopwatch()" +returns = "void" +file = "ProgressAggregatorTests.cs" + +[[methods]] +parent = "ProgressAggregatorTests" +name = "UpdateProgressInfo_ValueIsZero_ShouldNotThrow" +sig = "void UpdateProgressInfo_ValueIsZero_ShouldNotThrow()" +returns = "void" +file = "ProgressAggregatorTests.cs" + [[classes]] name = "ProgressServiceTests" ns = "FEx.MVVM.Tests" file = "ProgressServiceTests.cs" +[[methods]] +parent = "ProgressServiceTests" +name = "UnsubscribeFromProgress_NonExistentContainer_ShouldReturnFalse" +sig = "void UnsubscribeFromProgress_NonExistentContainer_ShouldReturnFalse()" +returns = "void" +file = "ProgressServiceTests.cs" + +[[methods]] +parent = "ProgressServiceTests" +name = "UnsubscribeFromProgress_NonExistentListener_ShouldReturnFalse" +sig = "void UnsubscribeFromProgress_NonExistentListener_ShouldReturnFalse()" +returns = "void" +file = "ProgressServiceTests.cs" + +[[methods]] +parent = "ProgressServiceTests" +name = "UnsubscribeFromProgress_ShouldNotReattachListener" +sig = "void UnsubscribeFromProgress_ShouldNotReattachListener()" +returns = "void" +file = "ProgressServiceTests.cs" + +[[methods]] +parent = "ProgressServiceTests" +name = "Instance_ShouldReturnSameInstance" +sig = "Task Instance_ShouldReturnSameInstance()" +returns = "Task" +file = "ProgressServiceTests.cs" + diff --git a/.api-surface/FEx/MVVM.toml b/.api-surface/FEx/MVVM.toml index dc77465c..ebde6b69 100644 --- a/.api-surface/FEx/MVVM.toml +++ b/.api-surface/FEx/MVVM.toml @@ -8,17 +8,46 @@ ns = "FEx.MVVM" base = "FExInitializable" file = "FExMvvm.cs" +[[properties]] +parent = "FExMvvm" +name = "DefaultUIRefreshInterval" +sig = "static TimeSpan DefaultUIRefreshInterval { get; set; }" +returns = "TimeSpan" +file = "FExMvvm.cs" +static = true + +[[properties]] +parent = "FExMvvm" +name = "MessagePopupService" +sig = "static IMessagePopupService MessagePopupService { get; }" +returns = "IMessagePopupService" +file = "FExMvvm.cs" +static = true + +[[ctors]] +parent = "FExMvvm" +sig = "FExMvvm(IMessagePopupService messagePopupService, IExceptionHandler exceptionHandler)" +file = "FExMvvm.cs" + +[[methods]] +parent = "FExMvvm" +name = "OnInitialize" +sig = "void OnInitialize()" +returns = "void" +file = "FExMvvm.cs" + [[classes]] name = "FExMvvmModule" ns = "FEx.MVVM" base = "InitializeModule" file = "FExMvvmModule.cs" -[[classes]] -name = "IsExternalInit" -ns = "System.Runtime.CompilerServices" -file = "IsExternalInit.cs" -static = true +[[methods]] +parent = "FExMvvmModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExMvvmContainer container, IServiceCollection services)" +returns = "void" +file = "FExMvvmModule.cs" [[classes]] name = "Link" @@ -26,61 +55,258 @@ ns = "FEx.MVVM" base = "ILink" file = "Link.cs" +[[properties]] +parent = "Link" +name = "PropertyType" +sig = "Type PropertyType { get; }" +returns = "Type" +file = "Link.cs" + +[[properties]] +parent = "Link" +name = "PropertyName" +sig = "string PropertyName { get; }" +returns = "string" +file = "Link.cs" + +[[properties]] +parent = "Link" +name = "Id" +sig = "Guid Id { get; }" +returns = "Guid" +file = "Link.cs" + +[[properties]] +parent = "Link" +name = "DefaultValue" +sig = "object DefaultValue { get; }" +returns = "object" +file = "Link.cs" + +[[ctors]] +parent = "Link" +sig = "Link(Type propertyType, ILinkableNotifyPropertyChanged sender, string propertyName, Func getPropertyValue, Action onPropertyChange, object defaultValue)" +file = "Link.cs" + +[[ctors]] +parent = "Link" +sig = "Link(Type propertyType, ILinkableNotifyPropertyChanged sender, string propertyName, Func getPropertyValue, Action onPropertyChange, object defaultValue, ILink parentLink)" +file = "Link.cs" + +[[methods]] +parent = "Link" +name = "UnlinkChildren" +sig = "void UnlinkChildren(bool resetPropertyValue)" +returns = "void" +file = "Link.cs" + +[[methods]] +parent = "Link" +name = "Unlink" +sig = "void Unlink(bool resetPropertyValue)" +returns = "void" +file = "Link.cs" + +[[methods]] +parent = "Link" +name = "ResetProperty" +sig = "void ResetProperty()" +returns = "void" +file = "Link.cs" + +[[methods]] +parent = "Link" +name = "GetPropertyValue" +sig = "object GetPropertyValue()" +returns = "object" +file = "Link.cs" + +[[methods]] +parent = "Link" +name = "OnPropertyChange" +sig = "void OnPropertyChange(object oldValue, object newValue)" +returns = "void" +file = "Link.cs" + +[[methods]] +parent = "Link" +name = "Initialize" +sig = "void Initialize()" +returns = "void" +file = "Link.cs" + +[[methods]] +parent = "Link" +name = "AddChild" +sig = "void AddChild(ILink link)" +returns = "void" +file = "Link.cs" + +[[methods]] +parent = "Link" +name = "RelinkChildren" +sig = "void RelinkChildren(T newSender, Action onNewSender) where T : ILinkableNotifyPropertyChanged" +returns = "void" +file = "Link.cs" + [[classes]] name = "SubscriberBase" ns = "FEx.MVVM.BaseObjects" base = "IDisposable" file = "BaseObjects\\SubscriberBase.cs" +[[properties]] +parent = "SubscriberBase" +name = "Subscriptions" +sig = "ConcurrentDictionary Subscriptions { get; }" +returns = "ConcurrentDictionary" +file = "BaseObjects\\SubscriberBase.cs" + +[[ctors]] +parent = "SubscriberBase" +sig = "SubscriberBase()" +file = "BaseObjects\\SubscriberBase.cs" + +[[methods]] +parent = "SubscriberBase" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "BaseObjects\\SubscriberBase.cs" + +[[methods]] +parent = "SubscriberBase" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +file = "BaseObjects\\SubscriberBase.cs" + [[classes]] name = "CheckedListItem" ns = "FEx.MVVM.Controls" base = "NotifyPropertyChanged" file = "Controls\\CheckedListItem.cs" +[[properties]] +parent = "CheckedListItem" +name = "Name" +sig = "string Name { get; set; }" +returns = "string" +file = "Controls\\CheckedListItem.cs" + +[[properties]] +parent = "CheckedListItem" +name = "IsChecked" +sig = "bool IsChecked { get; set; }" +returns = "bool" +file = "Controls\\CheckedListItem.cs" + +[[properties]] +parent = "CheckedListItem" +name = "IsEnabled" +sig = "bool IsEnabled { get; set; }" +returns = "bool" +file = "Controls\\CheckedListItem.cs" + +[[properties]] +parent = "CheckedListItem" +name = "ToolTip" +sig = "object ToolTip { get; set; }" +returns = "object" +file = "Controls\\CheckedListItem.cs" + +[[ctors]] +parent = "CheckedListItem" +sig = "CheckedListItem()" +file = "Controls\\CheckedListItem.cs" + +[[ctors]] +parent = "CheckedListItem" +sig = "CheckedListItem(string name, bool isEnabled = true, bool isChecked = false, object toolTip = null)" +file = "Controls\\CheckedListItem.cs" + [[classes]] name = "ViewField" ns = "FEx.MVVM.Controls" base = "NotifyPropertyChanged" file = "Controls\\ViewField.cs" +[[properties]] +parent = "ViewField" +name = "Header" +sig = "string Header { get; set; }" +returns = "string" +file = "Controls\\ViewField.cs" + +[[properties]] +parent = "ViewField" +name = "ToolTip" +sig = "string ToolTip { get; set; }" +returns = "string" +file = "Controls\\ViewField.cs" + +[[properties]] +parent = "ViewField" +name = "IsVisible" +sig = "bool IsVisible { get; set; }" +returns = "bool" +file = "Controls\\ViewField.cs" + +[[properties]] +parent = "ViewField" +name = "IsVisiblePersistence" +sig = "Action IsVisiblePersistence { get; set; }" +returns = "Action" +file = "Controls\\ViewField.cs" + +[[ctors]] +parent = "ViewField" +sig = "ViewField()" +file = "Controls\\ViewField.cs" + +[[ctors]] +parent = "ViewField" +sig = "ViewField(string header, string toolTip, bool isVisible, Action isVisiblePersistence)" +summary = "Initializes a new instance of the class." +file = "Controls\\ViewField.cs" + [[classes]] name = "ProgressAggregatorExtensions" ns = "FEx.MVVM.Extensions" file = "Extensions\\ProgressAggregatorExtensions.cs" static = true +[[properties]] +parent = "ProgressAggregatorExtensions" +name = "ListenerPropertyNames" +sig = "static IList ListenerPropertyNames { get; }" +returns = "IList" +file = "Extensions\\ProgressAggregatorExtensions.cs" +static = true + [[extensions]] name = "SetCurrentDownloadState" -sig = "void SetCurrentDownloadState(this IProgressAggregator viewModel, DownloadProgressChangedEventArgs e)" returns = "void" +sig = "void SetCurrentDownloadState(this IProgressAggregator viewModel, DownloadProgressChangedEventArgs e)" summary = "Sets the state of the current download." file = "Extensions\\ProgressAggregatorExtensions.cs" [[extensions]] name = "SetCurrentDownloadState" -sig = "void SetCurrentDownloadState(this IProgressAggregator viewModel, double? bytesReceived)" returns = "void" -summary = "Sets the state of the current download." +sig = "void SetCurrentDownloadState(this IProgressAggregator viewModel, double? bytesReceived)" file = "Extensions\\ProgressAggregatorExtensions.cs" [[extensions]] name = "SetCurrentDownloadState" -sig = "void SetCurrentDownloadState(this IProgressAggregator viewModel, - double? bytesReceived, - double? totalBytesToReceive)" returns = "void" -summary = "Sets the state of the current download." +sig = "void SetCurrentDownloadState(this IProgressAggregator viewModel, double? bytesReceived, double? totalBytesToReceive)" file = "Extensions\\ProgressAggregatorExtensions.cs" [[extensions]] name = "SetCurrentDownloadState" -sig = "void SetCurrentDownloadState(this IProgressAggregator viewModel, - double? bytesReceived, - double? totalBytesToReceive, - object userState)" returns = "void" -summary = "Sets the state of the current download." +sig = "void SetCurrentDownloadState(this IProgressAggregator viewModel, double? bytesReceived, double? totalBytesToReceive, object userState)" file = "Extensions\\ProgressAggregatorExtensions.cs" [[classes]] @@ -89,61 +315,488 @@ ns = "FEx.MVVM.Extensions" file = "Extensions\\PropertiesExtensions.cs" static = true +[[extensions]] +name = "SetPropertyFromExpression" +returns = "bool" +sig = "bool SetPropertyFromExpression(this object target, Expression> expression, T value)" +file = "Extensions\\PropertiesExtensions.cs" + +[[extensions]] +name = "SetPropertyFromExpression" +returns = "bool" +sig = "bool SetPropertyFromExpression(this object target, Expression> expression, T value, Action onSet)" +file = "Extensions\\PropertiesExtensions.cs" + +[[methods]] +parent = "PropertiesExtensions" +name = "FindMemberExpression" +sig = "static MemberExpression FindMemberExpression(Expression> expression)" +returns = "MemberExpression" +file = "Extensions\\PropertiesExtensions.cs" +static = true + +[[methods]] +parent = "PropertiesExtensions" +name = "FindMemberExpression" +sig = "static MemberExpression FindMemberExpression(Expression> expression)" +returns = "MemberExpression" +file = "Extensions\\PropertiesExtensions.cs" +static = true + +[[extensions]] +name = "LinkChild" +returns = "void" +sig = "void LinkChild(this T sender, Expression> property, Action onPropertyChange, ILink parentLink)" +file = "Extensions\\PropertiesExtensions.cs" + +[[extensions]] +name = "LinkChild" +returns = "void" +sig = "void LinkChild(this T sender, Expression> property, Action onPropertyChange, ILink parentLink)" +file = "Extensions\\PropertiesExtensions.cs" + +[[extensions]] +name = "LinkChild" +returns = "void" +sig = "void LinkChild(this T sender, Expression> property, Action onPropertyChange, ILink parentLink)" +file = "Extensions\\PropertiesExtensions.cs" + +[[extensions]] +name = "Link" +returns = "void" +sig = "void Link(this T sender, Expression> property, Action onPropertyChange)" +file = "Extensions\\PropertiesExtensions.cs" + +[[extensions]] +name = "Link" +returns = "void" +sig = "void Link(this T sender, Expression> property, Action onPropertyChange)" +file = "Extensions\\PropertiesExtensions.cs" + +[[extensions]] +name = "Link" +returns = "void" +sig = "void Link(this T sender, Expression> property, Action onPropertyChange)" +file = "Extensions\\PropertiesExtensions.cs" + [[interfaces]] name = "IAttachToContainerReceiver" ns = "FEx.MVVM.Interfaces" file = "Interfaces\\IAttachToContainerReceiver.cs" +[[methods]] +parent = "IAttachToContainerReceiver" +name = "SubscribeToProgress" +sig = "bool SubscribeToProgress(IProgressReceiver progressReceiver, params string[] iProgressReceiverProperties) where TCon : IProgressAggregator" +returns = "bool" +file = "Interfaces\\IAttachToContainerReceiver.cs" + +[[methods]] +parent = "IAttachToContainerReceiver" +name = "SubscribeToProgress" +sig = "bool SubscribeToProgress(string containerId, params string[] iProgressReceiverProperties)" +returns = "bool" +file = "Interfaces\\IAttachToContainerReceiver.cs" + +[[methods]] +parent = "IAttachToContainerReceiver" +name = "SubscribeToProgress" +sig = "bool SubscribeToProgress(IProgressAggregator container, params string[] iProgressReceiverProperties)" +returns = "bool" +file = "Interfaces\\IAttachToContainerReceiver.cs" + +[[methods]] +parent = "IAttachToContainerReceiver" +name = "UnsubscribeFromProgress" +sig = "bool UnsubscribeFromProgress(IProgressReceiver progressReceiver) where TCon : IProgressAggregator" +returns = "bool" +file = "Interfaces\\IAttachToContainerReceiver.cs" + +[[methods]] +parent = "IAttachToContainerReceiver" +name = "UnsubscribeFromProgress" +sig = "bool UnsubscribeFromProgress(string containerId)" +returns = "bool" +file = "Interfaces\\IAttachToContainerReceiver.cs" + +[[methods]] +parent = "IAttachToContainerReceiver" +name = "UnsubscribeFromProgress" +sig = "bool UnsubscribeFromProgress(IProgressAggregator container)" +returns = "bool" +file = "Interfaces\\IAttachToContainerReceiver.cs" + [[interfaces]] name = "IFExMvvmContainer" ns = "FEx.MVVM.Interfaces" +base = "IContainer, IContainer" file = "Interfaces\\IFExMvvmContainer.cs" [[interfaces]] name = "IProgressReceiver" ns = "FEx.MVVM.Interfaces" +base = "IAttachToContainerReceiver" summary = "Has progress status container instance" file = "Interfaces\\IProgressReceiver.cs" +[[properties]] +parent = "IProgressReceiver" +name = "Progress" +sig = "T Progress { get; }" +returns = "T" +file = "Interfaces\\IProgressReceiver.cs" + +[[properties]] +parent = "IProgressReceiver" +name = "Subscriptions" +sig = "ConcurrentDictionary Subscriptions { get; }" +returns = "ConcurrentDictionary" +file = "Interfaces\\IProgressReceiver.cs" + [[interfaces]] name = "IProgressService" ns = "FEx.MVVM.Interfaces" file = "Interfaces\\IProgressService.cs" +[[methods]] +parent = "IProgressService" +name = "SubscribeToProgress" +sig = "bool SubscribeToProgress(IProgressReceiver receiver, IProgressReceiver producer, params string[] iProgressReceiverProperties) where T : IProgressAggregator where TCon : IProgressAggregator" +returns = "bool" +file = "Interfaces\\IProgressService.cs" + +[[methods]] +parent = "IProgressService" +name = "SubscribeToProgress" +sig = "bool SubscribeToProgress(IProgressReceiver receiver, IProgressAggregator container, params string[] iProgressReceiverProperties) where TCon : IProgressAggregator" +returns = "bool" +file = "Interfaces\\IProgressService.cs" + +[[methods]] +parent = "IProgressService" +name = "SubscribeToProgress" +sig = "bool SubscribeToProgress(IProgressAggregator receiver, string containerId, params string[] iProgressReceiverProperties)" +returns = "bool" +file = "Interfaces\\IProgressService.cs" + +[[methods]] +parent = "IProgressService" +name = "UnsubscribeFromProgress" +sig = "bool UnsubscribeFromProgress(IProgressReceiver receiver, IProgressReceiver producer) where T : IProgressAggregator where TCon : IProgressAggregator" +returns = "bool" +file = "Interfaces\\IProgressService.cs" + +[[methods]] +parent = "IProgressService" +name = "UnsubscribeFromProgress" +sig = "bool UnsubscribeFromProgress(IProgressReceiver receiver, IProgressAggregator container) where TCon : IProgressAggregator" +returns = "bool" +file = "Interfaces\\IProgressService.cs" + +[[methods]] +parent = "IProgressService" +name = "UnsubscribeFromProgress" +sig = "bool UnsubscribeFromProgress(IProgressAggregator receiver, string containerId)" +returns = "bool" +file = "Interfaces\\IProgressService.cs" + +[[methods]] +parent = "IProgressService" +name = "GetOrAddContainer" +sig = "TCon GetOrAddContainer(bool isMain) where TCon : class, IProgressAggregator, new()" +returns = "TCon" +file = "Interfaces\\IProgressService.cs" + +[[methods]] +parent = "IProgressService" +name = "RemoveContainer" +sig = "void RemoveContainer(string id)" +returns = "void" +file = "Interfaces\\IProgressService.cs" + [[classes]] name = "NotifyProgressInfoChanged" ns = "FEx.MVVM.Models" base = "NotifyPropertyChanged" file = "Models\\NotifyProgressInfoChanged.cs" +[[properties]] +parent = "NotifyProgressInfoChanged" +name = "Value" +sig = "double? Value { get; set; }" +returns = "double?" +file = "Models\\NotifyProgressInfoChanged.cs" + +[[properties]] +parent = "NotifyProgressInfoChanged" +name = "Maximum" +sig = "double? Maximum { get; set; }" +returns = "double?" +file = "Models\\NotifyProgressInfoChanged.cs" + +[[properties]] +parent = "NotifyProgressInfoChanged" +name = "ChangeMode" +sig = "ProgressChangeMode ChangeMode { get; set; }" +returns = "ProgressChangeMode" +file = "Models\\NotifyProgressInfoChanged.cs" + [[classes]] name = "ProgressSnapshot" ns = "FEx.MVVM.Models" file = "Models\\ProgressSnapshot.cs" +[[properties]] +parent = "ProgressSnapshot" +name = "Maximum" +sig = "double Maximum { get; set; }" +returns = "double" +file = "Models\\ProgressSnapshot.cs" + +[[properties]] +parent = "ProgressSnapshot" +name = "Value" +sig = "double Value { get; set; }" +returns = "double" +file = "Models\\ProgressSnapshot.cs" + [[classes]] name = "MessagePopupServiceBase" ns = "FEx.MVVM.Services" base = "IMessagePopupService" file = "Services\\MessagePopupService.cs" +[[properties]] +parent = "MessagePopupServiceBase" +name = "AppIsClosing" +sig = "bool AppIsClosing { get; set; }" +returns = "bool" +file = "Services\\MessagePopupService.cs" + +[[ctors]] +parent = "MessagePopupServiceBase" +sig = "MessagePopupServiceBase(ILogger logger)" +file = "Services\\MessagePopupService.cs" + +[[methods]] +parent = "MessagePopupServiceBase" +name = "ShowMessageAsync" +sig = "Task ShowMessageAsync(string txt, string caption, MessageIcon messageBoxImage, FExMessageButton button, ISupportInitialize ownerWindow, bool informUser, bool wait, Stopwatch sw, LogLevel level, Exception exception)" +returns = "Task" +file = "Services\\MessagePopupService.cs" + +[[methods]] +parent = "MessagePopupServiceBase" +name = "ShowMessage" +sig = "MessageResult ShowMessage(string txt, string caption, MessageIcon messageBoxImage, FExMessageButton button, ISupportInitialize ownerWindow, bool informUser, bool wait, Stopwatch sw, LogLevel level, Exception exception)" +returns = "MessageResult" +file = "Services\\MessagePopupService.cs" + +[[methods]] +parent = "MessagePopupServiceBase" +name = "InternalShowMessageAsync" +sig = "Task InternalShowMessageAsync(string txt, string caption, MessageIcon messageBoxImage, FExMessageButton button, ISupportInitialize ownerWindow, bool informUser, bool wait, Stopwatch sw, LogLevel level, Exception exception)" +returns = "Task" +file = "Services\\MessagePopupService.cs" + [[classes]] name = "ProgressService" ns = "FEx.MVVM.Services" base = "SubscriberBase, IProgressService" file = "Services\\ProgressService.cs" +[[properties]] +parent = "ProgressService" +name = "MainContainerId" +sig = "static string MainContainerId { get; }" +returns = "string" +file = "Services\\ProgressService.cs" +static = true + +[[properties]] +parent = "ProgressService" +name = "Instance" +sig = "static ProgressService Instance { get; }" +returns = "ProgressService" +file = "Services\\ProgressService.cs" +static = true + +[[properties]] +parent = "ProgressService" +name = "Containers" +sig = "ConcurrentDictionary Containers { get; }" +returns = "ConcurrentDictionary" +file = "Services\\ProgressService.cs" + +[[properties]] +parent = "ProgressService" +name = "Listeners" +sig = "ConcurrentDictionary> Listeners { get; }" +returns = "ConcurrentDictionary>" +file = "Services\\ProgressService.cs" + +[[methods]] +parent = "ProgressService" +name = "SubscribeToProgress" +sig = "bool SubscribeToProgress(IProgressReceiver receiver, IProgressReceiver producer, params string[] iProgressReceiverProperties) where T : IProgressAggregator where TCon : IProgressAggregator" +returns = "bool" +file = "Services\\ProgressService.cs" + +[[methods]] +parent = "ProgressService" +name = "SubscribeToProgress" +sig = "bool SubscribeToProgress(IProgressReceiver receiver, IProgressAggregator container, params string[] iProgressReceiverProperties) where TCon : IProgressAggregator" +returns = "bool" +file = "Services\\ProgressService.cs" + +[[methods]] +parent = "ProgressService" +name = "SubscribeToProgress" +sig = "bool SubscribeToProgress(IProgressAggregator receiver, string containerId, params string[] iProgressReceiverProperties)" +returns = "bool" +file = "Services\\ProgressService.cs" + +[[methods]] +parent = "ProgressService" +name = "UnsubscribeFromProgress" +sig = "bool UnsubscribeFromProgress(IProgressReceiver receiver, IProgressReceiver producer) where T : IProgressAggregator where TCon : IProgressAggregator" +returns = "bool" +file = "Services\\ProgressService.cs" + +[[methods]] +parent = "ProgressService" +name = "UnsubscribeFromProgress" +sig = "bool UnsubscribeFromProgress(IProgressReceiver receiver, IProgressAggregator container) where TCon : IProgressAggregator" +returns = "bool" +file = "Services\\ProgressService.cs" + +[[methods]] +parent = "ProgressService" +name = "UnsubscribeFromProgress" +sig = "bool UnsubscribeFromProgress(IProgressAggregator receiver, string containerId)" +returns = "bool" +file = "Services\\ProgressService.cs" + +[[methods]] +parent = "ProgressService" +name = "GetOrAddContainer" +sig = "TCon GetOrAddContainer(bool isMain) where TCon : class, IProgressAggregator, new()" +returns = "TCon" +file = "Services\\ProgressService.cs" + +[[methods]] +parent = "ProgressService" +name = "RemoveContainer" +sig = "void RemoveContainer(string id)" +returns = "void" +file = "Services\\ProgressService.cs" + +[[methods]] +parent = "ProgressService" +name = "GetOrAddContainer" +sig = "TCon GetOrAddContainer() where TCon : class, IProgressAggregator, new()" +returns = "TCon" +file = "Services\\ProgressService.cs" + [[classes]] name = "ReceiverDefinition" ns = "FEx.MVVM.Services" base = "IEquatable" file = "Services\\ReceiverDefinition.cs" +[[properties]] +parent = "ReceiverDefinition" +name = "Container" +sig = "IProgressAggregator Container { get; }" +returns = "IProgressAggregator" +file = "Services\\ReceiverDefinition.cs" + +[[properties]] +parent = "ReceiverDefinition" +name = "PropertyNames" +sig = "IList PropertyNames { get; }" +returns = "IList" +file = "Services\\ReceiverDefinition.cs" + +[[ctors]] +parent = "ReceiverDefinition" +sig = "ReceiverDefinition(IProgressAggregator container, params string[] propertyNames)" +file = "Services\\ReceiverDefinition.cs" + +[[methods]] +parent = "ReceiverDefinition" +name = "Equals" +sig = "bool Equals(ReceiverDefinition other)" +returns = "bool" +file = "Services\\ReceiverDefinition.cs" + +[[methods]] +parent = "ReceiverDefinition" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +file = "Services\\ReceiverDefinition.cs" + +[[methods]] +parent = "ReceiverDefinition" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +file = "Services\\ReceiverDefinition.cs" + +[[methods]] +parent = "ReceiverDefinition" +name = "IsReceivingThisProperty" +sig = "bool IsReceivingThisProperty(string propertyName)" +returns = "bool" +file = "Services\\ReceiverDefinition.cs" + [[interfaces]] name = "IProgressChange" ns = "FEx.MVVM.Subjects" file = "Subjects\\IProgressChange.cs" +[[properties]] +parent = "IProgressChange" +name = "PropertyName" +sig = "string PropertyName { get; }" +returns = "string" +file = "Subjects\\IProgressChange.cs" + +[[properties]] +parent = "IProgressChange" +name = "ChangeMode" +sig = "ProgressChangeMode ChangeMode { get; }" +returns = "ProgressChangeMode" +file = "Subjects\\IProgressChange.cs" + +[[classes]] +name = "ProgressChange" +ns = "FEx.MVVM.Subjects" +base = "IProgressChange" +file = "Subjects\\ProgressChange.cs" + +[[properties]] +parent = "ProgressChange" +name = "PropertyName" +sig = "string PropertyName { get; init; }" +returns = "string" +file = "Subjects\\ProgressChange.cs" + +[[properties]] +parent = "ProgressChange" +name = "Value" +sig = "T Value { get; init; }" +returns = "T" +file = "Subjects\\ProgressChange.cs" + +[[properties]] +parent = "ProgressChange" +name = "ChangeMode" +sig = "ProgressChangeMode ChangeMode { get; init; }" +returns = "ProgressChangeMode" +file = "Subjects\\ProgressChange.cs" + [[classes]] name = "ProgressChangeSubject" ns = "FEx.MVVM.Subjects" @@ -156,27 +809,662 @@ ns = "FEx.MVVM.Subjects" base = "LinkableNotifyPropertyChanged, IProgressStatus" file = "Subjects\\ProgressStatus.cs" +[[properties]] +parent = "ProgressStatus" +name = "Value" +sig = "double Value { get; set; }" +returns = "double" +file = "Subjects\\ProgressStatus.cs" + +[[properties]] +parent = "ProgressStatus" +name = "Maximum" +sig = "double Maximum { get; set; }" +returns = "double" +file = "Subjects\\ProgressStatus.cs" + +[[properties]] +parent = "ProgressStatus" +name = "IsIndeterminate" +sig = "bool IsIndeterminate { get; set; }" +returns = "bool" +file = "Subjects\\ProgressStatus.cs" + +[[properties]] +parent = "ProgressStatus" +name = "Percentage" +sig = "double Percentage { get; }" +returns = "double" +file = "Subjects\\ProgressStatus.cs" + +[[properties]] +parent = "ProgressStatus" +name = "PrecisePercentage" +sig = "double PrecisePercentage { get; set; }" +returns = "double" +file = "Subjects\\ProgressStatus.cs" + +[[properties]] +parent = "ProgressStatus" +name = "Info" +sig = "string Info { get; set; }" +returns = "string" +file = "Subjects\\ProgressStatus.cs" + +[[properties]] +parent = "ProgressStatus" +name = "Unit" +sig = "string Unit { get; set; }" +returns = "string" +file = "Subjects\\ProgressStatus.cs" + +[[properties]] +parent = "ProgressStatus" +name = "Mode" +sig = "ProgressOperationMode Mode { get; set; }" +returns = "ProgressOperationMode" +file = "Subjects\\ProgressStatus.cs" + +[[properties]] +parent = "ProgressStatus" +name = "State" +sig = "ProgressState State { get; set; }" +returns = "ProgressState" +file = "Subjects\\ProgressStatus.cs" + +[[properties]] +parent = "ProgressStatus" +name = "IsBusy" +sig = "bool IsBusy { get; }" +returns = "bool" +file = "Subjects\\ProgressStatus.cs" + +[[properties]] +parent = "ProgressStatus" +name = "IsInfoVisible" +sig = "bool? IsInfoVisible { get; set; }" +returns = "bool?" +file = "Subjects\\ProgressStatus.cs" + +[[properties]] +parent = "ProgressStatus" +name = "StatusInfo" +sig = "string StatusInfo { get; set; }" +returns = "string" +file = "Subjects\\ProgressStatus.cs" + +[[properties]] +parent = "ProgressStatus" +name = "CurrItemInfo" +sig = "string CurrItemInfo { get; set; }" +returns = "string" +file = "Subjects\\ProgressStatus.cs" + +[[properties]] +parent = "ProgressStatus" +name = "ThreadsInfo" +sig = "string ThreadsInfo { get; set; }" +returns = "string" +file = "Subjects\\ProgressStatus.cs" + +[[properties]] +parent = "ProgressStatus" +name = "ExcludedProperties" +sig = "ConcurrentHashSet ExcludedProperties { get; }" +returns = "ConcurrentHashSet" +file = "Subjects\\ProgressStatus.cs" + +[[ctors]] +parent = "ProgressStatus" +sig = "ProgressStatus()" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "OnPropertyChanged" +sig = "void OnPropertyChanged(string propertyName = null)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "InvokePropertyChanged" +sig = "void InvokePropertyChanged(string propertyName)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "OnStateChanged" +sig = "void OnStateChanged(ProgressState state)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "OnValueChanged" +sig = "void OnValueChanged(double value)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "OnMaximumChanged" +sig = "void OnMaximumChanged(double value)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "OnIsIndeterminateChanged" +sig = "void OnIsIndeterminateChanged(bool value)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "OnExcludedPropertyChanged" +sig = "void OnExcludedPropertyChanged(string propertyName)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "RefreshIsPrgInfoVisible" +sig = "void RefreshIsPrgInfoVisible()" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "CalculateProgressPercentage" +sig = "void CalculateProgressPercentage()" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "OnStatusInfoChanged" +sig = "void OnStatusInfoChanged(string value)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "SetValue" +sig = "void SetValue(double value)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "SetMaximum" +sig = "void SetMaximum(double value)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "SetIsIndeterminate" +sig = "void SetIsIndeterminate(bool value)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "SetPrecisePercentage" +sig = "void SetPrecisePercentage(double value)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "SetInfo" +sig = "void SetInfo(string value)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "SetUnit" +sig = "void SetUnit(string value)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "SetMode" +sig = "void SetMode(ProgressOperationMode value)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "SetIsFileOperation" +sig = "void SetIsFileOperation(bool value)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "SetState" +sig = "void SetState(ProgressState value)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "SetIsBusy" +sig = "void SetIsBusy(bool value)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "Busy" +sig = "void Busy()" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "Idle" +sig = "void Idle()" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "SetIsInfoVisible" +sig = "void SetIsInfoVisible(bool? value)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "SetStatusInfo" +sig = "void SetStatusInfo(string value)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "SetCurrItemInfo" +sig = "void SetCurrItemInfo(string value)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + +[[methods]] +parent = "ProgressStatus" +name = "SetThreadsInfo" +sig = "void SetThreadsInfo(string value)" +returns = "void" +file = "Subjects\\ProgressStatus.cs" + [[classes]] name = "BufferedProgressAggregator" ns = "FEx.MVVM.Utilities" base = "ProgressAggregator" file = "Utilities\\BufferedProgressAggregator.cs" +[[properties]] +parent = "BufferedProgressAggregator" +name = "ChangesBufferingDelay" +sig = "static TimeSpan ChangesBufferingDelay { get; set; }" +returns = "TimeSpan" +file = "Utilities\\BufferedProgressAggregator.cs" +static = true + +[[ctors]] +parent = "BufferedProgressAggregator" +sig = "BufferedProgressAggregator()" +file = "Utilities\\BufferedProgressAggregator.cs" + +[[methods]] +parent = "BufferedProgressAggregator" +name = "PrgSet" +sig = "void PrgSet(double? value, double? maximum, ProgressChangeMode mode)" +returns = "void" +summary = "Sets current progress value and maximal allowed value of the ProgressBar" +file = "Utilities\\BufferedProgressAggregator.cs" + +[[methods]] +parent = "BufferedProgressAggregator" +name = "ProcessChange" +sig = "void ProcessChange(IProgressChange progressChange)" +returns = "void" +file = "Utilities\\BufferedProgressAggregator.cs" + +[[methods]] +parent = "BufferedProgressAggregator" +name = "ChangeDoubleValues" +sig = "void ChangeDoubleValues(ProgressChange progressChange)" +returns = "void" +file = "Utilities\\BufferedProgressAggregator.cs" + +[[methods]] +parent = "BufferedProgressAggregator" +name = "ChangeDoubleValue" +sig = "void ChangeDoubleValue(ProgressChange progressChange, Func get, Action set)" +returns = "void" +file = "Utilities\\BufferedProgressAggregator.cs" + +[[methods]] +parent = "BufferedProgressAggregator" +name = "ProcessProgressChange" +sig = "void ProcessProgressChange(ProgressChange progressChange)" +returns = "void" +file = "Utilities\\BufferedProgressAggregator.cs" + +[[methods]] +parent = "BufferedProgressAggregator" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +file = "Utilities\\BufferedProgressAggregator.cs" + [[classes]] name = "FExTimer" ns = "FEx.MVVM.Utilities" base = "NotifyPropertyChanged, IFExTimer" file = "Utilities\\FExTimer.cs" +[[properties]] +parent = "FExTimer" +name = "Interval" +sig = "TimeSpan Interval { get; set; }" +returns = "TimeSpan" +summary = "The timer interval" +file = "Utilities\\FExTimer.cs" + +[[properties]] +parent = "FExTimer" +name = "IsRunning" +sig = "bool IsRunning { get; set; }" +returns = "bool" +summary = "Indicates whether this timer is running." +file = "Utilities\\FExTimer.cs" + +[[properties]] +parent = "FExTimer" +name = "IntervalObservable" +sig = "IObservable IntervalObservable { get; }" +returns = "IObservable" +file = "Utilities\\FExTimer.cs" + +[[ctors]] +parent = "FExTimer" +sig = "FExTimer()" +file = "Utilities\\FExTimer.cs" + +[[methods]] +parent = "FExTimer" +name = "WithCallback" +sig = "IFExTimer WithCallback(Action callback)" +returns = "IFExTimer" +summary = "Sets the timer callback. Subscribes to using the current . Important: Call before this method. Calling WithInterval after WithCallback does not update the existing subscription." +file = "Utilities\\FExTimer.cs" + +[[methods]] +parent = "FExTimer" +name = "WithAsyncCallback" +sig = "IFExTimer WithAsyncCallback(Func asyncCallback, CancellationToken cancellationToken)" +returns = "IFExTimer" +summary = "Sets the async timer callback. Subscribes to using the current . Important: Call before this method. Calling WithInterval after WithAsyncCallback does not update the existing subscription." +file = "Utilities\\FExTimer.cs" + +[[methods]] +parent = "FExTimer" +name = "WithInterval" +sig = "IFExTimer WithInterval(double milliseconds)" +returns = "IFExTimer" +file = "Utilities\\FExTimer.cs" + +[[methods]] +parent = "FExTimer" +name = "WithInterval" +sig = "IFExTimer WithInterval(TimeSpan interval)" +returns = "IFExTimer" +file = "Utilities\\FExTimer.cs" + +[[methods]] +parent = "FExTimer" +name = "Start" +sig = "void Start()" +returns = "void" +summary = "Starts the timer." +file = "Utilities\\FExTimer.cs" + +[[methods]] +parent = "FExTimer" +name = "Stop" +sig = "void Stop()" +returns = "void" +summary = "Stops the timer." +file = "Utilities\\FExTimer.cs" + +[[methods]] +parent = "FExTimer" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +file = "Utilities\\FExTimer.cs" + +[[methods]] +parent = "FExTimer" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Utilities\\FExTimer.cs" + [[classes]] name = "ProgressAggregator" ns = "FEx.MVVM.Utilities" base = "ProgressStatus, IProgressAggregator" file = "Utilities\\ProgressAggregator.cs" +[[properties]] +parent = "ProgressAggregator" +name = "Stopwatch" +sig = "Stopwatch Stopwatch { get; }" +returns = "Stopwatch" +file = "Utilities\\ProgressAggregator.cs" + +[[properties]] +parent = "ProgressAggregator" +name = "Timer" +sig = "IFExTimer Timer { get; }" +returns = "IFExTimer" +file = "Utilities\\ProgressAggregator.cs" + +[[properties]] +parent = "ProgressAggregator" +name = "Id" +sig = "string Id { get; }" +returns = "string" +file = "Utilities\\ProgressAggregator.cs" + +[[ctors]] +parent = "ProgressAggregator" +sig = "ProgressAggregator()" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "SetProperty" +sig = "bool SetProperty(ref TRet backingField, TRet newValue, Action onPropertyChanged = null, [CallerMemberName] string propertyName = null)" +returns = "bool" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "Start" +sig = "void Start()" +returns = "void" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "Stop" +sig = "void Stop()" +returns = "void" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "Report" +sig = "void Report(string propertyName, object value)" +returns = "void" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "GetProperties" +sig = "List GetProperties()" +returns = "List" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "SetProperty" +sig = "bool SetProperty(ref TRet backingField, TRet newValue, [CallerMemberName] string propertyName = null)" +returns = "bool" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "LogError" +sig = "void LogError(string message)" +returns = "void" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "ProcessEndPrg" +sig = "void ProcessEndPrg()" +returns = "void" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "ProcessSetPrg" +sig = "void ProcessSetPrg(double? value, double? maximum)" +returns = "void" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "ProcessAddPrg" +sig = "void ProcessAddPrg(double? value, double? maximum)" +returns = "void" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "TimerCallback" +sig = "void TimerCallback()" +returns = "void" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "UpdateProgressInfo" +sig = "void UpdateProgressInfo()" +returns = "void" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "OnExcludedPropertyChanged" +sig = "void OnExcludedPropertyChanged(string propertyName)" +returns = "void" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "InvokeProgressPropertyChanged" +sig = "void InvokeProgressPropertyChanged(TRet newValue, string propertyName)" +returns = "void" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "PrgSet" +sig = "void PrgSet(double? value)" +returns = "void" +summary = "Sets current progress value and maximal allowed value of the ProgressBar" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "PrgSet" +sig = "void PrgSet(double? value, double? maximum)" +returns = "void" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "PrgSet" +sig = "void PrgSet(double? value, double? maximum, ProgressChangeMode mode)" +returns = "void" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "PrgSetEnd" +sig = "void PrgSetEnd()" +returns = "void" +summary = "Sets progress value of the ProgressBar to the maximal value" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "PrgAdd" +sig = "void PrgAdd(double addedValue)" +returns = "void" +summary = "Increments current progress value of the ProgressBar" +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "PrgMaxAdd" +sig = "void PrgMaxAdd(double addedValue)" +returns = "void" +summary = "Adds value to the maximum of progress value." +file = "Utilities\\ProgressAggregator.cs" + +[[methods]] +parent = "ProgressAggregator" +name = "PrgSetMax" +sig = "void PrgSetMax(double max)" +returns = "void" +summary = "Sets maximal allowed value of the ProgressBar and resets current progress" +file = "Utilities\\ProgressAggregator.cs" + [[classes]] name = "ProgressChangesBuffer" ns = "FEx.MVVM.Utilities" base = "AsyncBuffer>" file = "Utilities\\ProgressChangesBuffer.cs" +[[methods]] +parent = "ProgressChangesBuffer" +name = "RetrieveFromBuffer" +sig = "IList> RetrieveFromBuffer( IList> buffer)" +returns = "IList>" +file = "Utilities\\ProgressChangesBuffer.cs" + diff --git a/.api-surface/FEx/Maui.toml b/.api-surface/FEx/Maui.toml index 44f98d6a..63fcb52a 100644 --- a/.api-surface/FEx/Maui.toml +++ b/.api-surface/FEx/Maui.toml @@ -8,3 +8,62 @@ ns = "FEx.Maui" base = "FExDispatcher" file = "FExMauiDispatcher.cs" +[[ctors]] +parent = "FExMauiDispatcher" +sig = "FExMauiDispatcher(ILogger logger, IMainThreadContextProvider mainThreadContextProvider, IDeadlockMonitor deadlockMonitor, IStackTraceProvider stackTraceProvider)" +file = "FExMauiDispatcher.cs" + +[[ctors]] +parent = "FExMauiDispatcher" +sig = "FExMauiDispatcher(ILogger logger, IMainThreadContextProvider mainThreadContextProvider, IDeadlockMonitor deadlockMonitor, IStackTraceProvider stackTraceProvider, bool isDeadlockMonitoringEnabled)" +file = "FExMauiDispatcher.cs" + +[[methods]] +parent = "FExMauiDispatcher" +name = "BeginInvokeOnMainThread" +sig = "void BeginInvokeOnMainThread(Action action, object sender)" +returns = "void" +file = "FExMauiDispatcher.cs" + +[[methods]] +parent = "FExMauiDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Action action, object sender)" +returns = "Task" +file = "FExMauiDispatcher.cs" + +[[methods]] +parent = "FExMauiDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func func, object sender)" +returns = "Task" +file = "FExMauiDispatcher.cs" + +[[methods]] +parent = "FExMauiDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func> funcTask, object sender)" +returns = "Task" +file = "FExMauiDispatcher.cs" + +[[methods]] +parent = "FExMauiDispatcher" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func funcTask, object sender)" +returns = "Task" +file = "FExMauiDispatcher.cs" + +[[methods]] +parent = "FExMauiDispatcher" +name = "CheckAccess" +sig = "bool CheckAccess(object sender)" +returns = "bool" +file = "FExMauiDispatcher.cs" + +[[methods]] +parent = "FExMauiDispatcher" +name = "EnableCollectionSynchronization" +sig = "void EnableCollectionSynchronization(IEnumerable collection, object context, Action callback)" +returns = "void" +file = "FExMauiDispatcher.cs" + diff --git a/.api-surface/FEx/McpServer.toml b/.api-surface/FEx/McpServer.toml index d05e5eb3..f88180db 100644 --- a/.api-surface/FEx/McpServer.toml +++ b/.api-surface/FEx/McpServer.toml @@ -2,24 +2,169 @@ name = "FEx.McpServer" path = "tools\\FEx.McpServer" +[[enums]] +name = "ApiEntryType" +ns = "FEx.McpServer.Services" +file = "Services\\ApiEntry.cs" + [[classes]] name = "ApiEntry" ns = "FEx.McpServer.Services" file = "Services\\ApiEntry.cs" +[[properties]] +parent = "ApiEntry" +name = "Type" +sig = "ApiEntryType Type { get; init; }" +returns = "ApiEntryType" +file = "Services\\ApiEntry.cs" + +[[properties]] +parent = "ApiEntry" +name = "Name" +sig = "string Name { get; init; }" +returns = "string" +file = "Services\\ApiEntry.cs" + +[[properties]] +parent = "ApiEntry" +name = "Namespace" +sig = "string Namespace { get; init; }" +returns = "string" +file = "Services\\ApiEntry.cs" + +[[properties]] +parent = "ApiEntry" +name = "Project" +sig = "string Project { get; init; }" +returns = "string" +file = "Services\\ApiEntry.cs" + +[[properties]] +parent = "ApiEntry" +name = "File" +sig = "string File { get; init; }" +returns = "string" +file = "Services\\ApiEntry.cs" + +[[properties]] +parent = "ApiEntry" +name = "Summary" +sig = "string Summary { get; init; }" +returns = "string" +file = "Services\\ApiEntry.cs" + +[[properties]] +parent = "ApiEntry" +name = "Signature" +sig = "string Signature { get; init; }" +returns = "string" +file = "Services\\ApiEntry.cs" + +[[properties]] +parent = "ApiEntry" +name = "Returns" +sig = "string Returns { get; init; }" +returns = "string" +file = "Services\\ApiEntry.cs" + +[[properties]] +parent = "ApiEntry" +name = "Base" +sig = "string Base { get; init; }" +returns = "string" +file = "Services\\ApiEntry.cs" + +[[properties]] +parent = "ApiEntry" +name = "IsStatic" +sig = "bool IsStatic { get; init; }" +returns = "bool" +file = "Services\\ApiEntry.cs" + +[[properties]] +parent = "ApiEntry" +name = "Parent" +sig = "string Parent { get; init; }" +returns = "string" +file = "Services\\ApiEntry.cs" + +[[properties]] +parent = "ApiEntry" +name = "IsMember" +sig = "bool IsMember { get; }" +returns = "bool" +file = "Services\\ApiEntry.cs" + [[classes]] name = "ProjectInfo" ns = "FEx.McpServer.Services" file = "Services\\ApiEntry.cs" +[[properties]] +parent = "ProjectInfo" +name = "Name" +sig = "string Name { get; init; }" +returns = "string" +file = "Services\\ApiEntry.cs" + +[[properties]] +parent = "ProjectInfo" +name = "Path" +sig = "string Path { get; init; }" +returns = "string" +file = "Services\\ApiEntry.cs" + +[[properties]] +parent = "ProjectInfo" +name = "Classes" +sig = "int Classes { get; init; }" +returns = "int" +file = "Services\\ApiEntry.cs" + +[[properties]] +parent = "ProjectInfo" +name = "Interfaces" +sig = "int Interfaces { get; init; }" +returns = "int" +file = "Services\\ApiEntry.cs" + +[[properties]] +parent = "ProjectInfo" +name = "Enums" +sig = "int Enums { get; init; }" +returns = "int" +file = "Services\\ApiEntry.cs" + +[[properties]] +parent = "ProjectInfo" +name = "Extensions" +sig = "int Extensions { get; init; }" +returns = "int" +file = "Services\\ApiEntry.cs" + [[classes]] name = "ApiSurfaceConfig" ns = "FEx.McpServer.Services" file = "Services\\ApiEntry.cs" -[[enums]] -name = "ApiEntryType" -ns = "FEx.McpServer.Services" +[[properties]] +parent = "ApiSurfaceConfig" +name = "ApiSurfacePath" +sig = "string ApiSurfacePath { get; }" +returns = "string" +file = "Services\\ApiEntry.cs" + +[[properties]] +parent = "ApiSurfaceConfig" +name = "RepoPath" +sig = "string RepoPath { get; }" +returns = "string" +file = "Services\\ApiEntry.cs" + +[[ctors]] +parent = "ApiSurfaceConfig" +sig = "ApiSurfaceConfig(string apiSurfacePath, string repoPath)" file = "Services\\ApiEntry.cs" [[classes]] @@ -27,8 +172,80 @@ name = "TomlApiSurfaceReader" ns = "FEx.McpServer.Services" file = "Services\\TomlApiSurfaceReader.cs" +[[ctors]] +parent = "TomlApiSurfaceReader" +sig = "TomlApiSurfaceReader(ApiSurfaceConfig config, ILogger logger)" +file = "Services\\TomlApiSurfaceReader.cs" + +[[properties]] +parent = "TomlApiSurfaceReader" +name = "Entries" +sig = "IReadOnlyList Entries { get; }" +returns = "IReadOnlyList" +file = "Services\\TomlApiSurfaceReader.cs" + +[[properties]] +parent = "TomlApiSurfaceReader" +name = "Projects" +sig = "IReadOnlyList Projects { get; }" +returns = "IReadOnlyList" +file = "Services\\TomlApiSurfaceReader.cs" + +[[properties]] +parent = "TomlApiSurfaceReader" +name = "GitCommit" +sig = "string GitCommit { get; }" +returns = "string" +file = "Services\\TomlApiSurfaceReader.cs" + +[[properties]] +parent = "TomlApiSurfaceReader" +name = "Generated" +sig = "string Generated { get; }" +returns = "string" +file = "Services\\TomlApiSurfaceReader.cs" + +[[methods]] +parent = "TomlApiSurfaceReader" +name = "Search" +sig = "List Search(string query, string project, string type)" +returns = "List" +file = "Services\\TomlApiSurfaceReader.cs" + [[classes]] name = "FExApiTools" ns = "FEx.McpServer.Tools" file = "Tools\\FExApiTools.cs" +[[methods]] +parent = "FExApiTools" +name = "SearchApi" +sig = "static string SearchApi( TomlApiSurfaceReader reader, [Description(\"Search query: class name, method name, interface, namespace, or description\")] string query, [Description(\"Filter by project name (e.g. 'Core.Abstractions', 'MVVM')\")] string project = \"\", [Description(\"Filter by type: class, interface, enum, extension\")] string type = \"\")" +returns = "string" +file = "Tools\\FExApiTools.cs" +static = true + +[[methods]] +parent = "FExApiTools" +name = "ListProjects" +sig = "static string ListProjects(TomlApiSurfaceReader reader)" +returns = "string" +file = "Tools\\FExApiTools.cs" +static = true + +[[methods]] +parent = "FExApiTools" +name = "GetProjectApi" +sig = "static string GetProjectApi( TomlApiSurfaceReader reader, [Description(\"Project name (e.g. 'FEx.Core.Abstractions', 'FEx.MVVM', or just 'Core.Abstractions')\")] string project)" +returns = "string" +file = "Tools\\FExApiTools.cs" +static = true + +[[methods]] +parent = "FExApiTools" +name = "CheckFreshness" +sig = "static string CheckFreshness( TomlApiSurfaceReader reader, ApiSurfaceConfig config)" +returns = "string" +file = "Tools\\FExApiTools.cs" +static = true + diff --git a/.api-surface/FEx/NuGetx.toml b/.api-surface/FEx/NuGetx.toml index 0ec2ceed..251996c1 100644 --- a/.api-surface/FEx/NuGetx.toml +++ b/.api-surface/FEx/NuGetx.toml @@ -5,6 +5,7 @@ path = "src\\FEx.NuGetx" [[interfaces]] name = "INuGetExModule" ns = "FEx.NuGetx" +base = "IContainer, IContainer, IContainer>" file = "INuGetExModule.cs" [[classes]] @@ -13,26 +14,248 @@ ns = "FEx.NuGetx" base = "InitializeModule" file = "NuGetEx.cs" +[[methods]] +parent = "NuGetEx" +name = "RegisterServices" +sig = "void RegisterServices(INuGetExModule container, IServiceCollection services)" +returns = "void" +file = "NuGetEx.cs" + [[classes]] name = "NuGetExModule" ns = "FEx.NuGetx" file = "NuGetExModule.cs" +[[methods]] +parent = "NuGetExModule" +name = "AddServices" +sig = "static void AddServices(INuGetExModule container, IServiceCollection services)" +returns = "void" +file = "NuGetExModule.cs" +static = true + [[classes]] name = "NuGetLogger" ns = "FEx.NuGetx" base = "INuGetLogger" file = "NuGetLogger.cs" +[[ctors]] +parent = "NuGetLogger" +sig = "NuGetLogger(ILogger logger)" +file = "NuGetLogger.cs" + +[[methods]] +parent = "NuGetLogger" +name = "LogDebug" +sig = "void LogDebug(string data)" +returns = "void" +file = "NuGetLogger.cs" + +[[methods]] +parent = "NuGetLogger" +name = "LogVerbose" +sig = "void LogVerbose(string data)" +returns = "void" +file = "NuGetLogger.cs" + +[[methods]] +parent = "NuGetLogger" +name = "LogInformation" +sig = "void LogInformation(string data)" +returns = "void" +file = "NuGetLogger.cs" + +[[methods]] +parent = "NuGetLogger" +name = "LogMinimal" +sig = "void LogMinimal(string data)" +returns = "void" +file = "NuGetLogger.cs" + +[[methods]] +parent = "NuGetLogger" +name = "LogWarning" +sig = "void LogWarning(string data)" +returns = "void" +file = "NuGetLogger.cs" + +[[methods]] +parent = "NuGetLogger" +name = "LogError" +sig = "void LogError(string data)" +returns = "void" +file = "NuGetLogger.cs" + +[[methods]] +parent = "NuGetLogger" +name = "LogInformationSummary" +sig = "void LogInformationSummary(string data)" +returns = "void" +file = "NuGetLogger.cs" + +[[methods]] +parent = "NuGetLogger" +name = "Log" +sig = "void Log(NuGetLogLevel level, string data)" +returns = "void" +file = "NuGetLogger.cs" + +[[methods]] +parent = "NuGetLogger" +name = "Log" +sig = "void Log(ILogMessage message)" +returns = "void" +file = "NuGetLogger.cs" + +[[methods]] +parent = "NuGetLogger" +name = "LogAsync" +sig = "Task LogAsync(NuGetLogLevel level, string data)" +returns = "Task" +file = "NuGetLogger.cs" + +[[methods]] +parent = "NuGetLogger" +name = "LogAsync" +sig = "Task LogAsync(ILogMessage message)" +returns = "Task" +file = "NuGetLogger.cs" + +[[methods]] +parent = "NuGetLogger" +name = "LogSummary" +sig = "void LogSummary(string data)" +returns = "void" +file = "NuGetLogger.cs" + +[[methods]] +parent = "NuGetLogger" +name = "Dump" +sig = "void Dump(LogLevel logLevel, string content)" +returns = "void" +file = "NuGetLogger.cs" + [[classes]] name = "NuGetManager" ns = "FEx.NuGetx" base = "AsyncInitializable" file = "NuGetManager.cs" +[[ctors]] +parent = "NuGetManager" +sig = "NuGetManager(NuGetLogger logger)" +file = "NuGetManager.cs" + +[[methods]] +parent = "NuGetManager" +name = "GetNuGetOrgPackageMetadataResourceAsync" +sig = "static Task GetNuGetOrgPackageMetadataResourceAsync()" +returns = "Task" +file = "NuGetManager.cs" +static = true + +[[methods]] +parent = "NuGetManager" +name = "GetIdentitiesAsync" +sig = "static Task GetIdentitiesAsync( PackageSearchMetadataBuilder.ClonedPackageSearchMetadata package)" +returns = "Task" +file = "NuGetManager.cs" +static = true + +[[methods]] +parent = "NuGetManager" +name = "GetPackageDependenciesAsync" +sig = "static Task GetPackageDependenciesAsync(PackageIdentity package, NuGetFramework framework, SourceCacheContext cacheContext, INuGetLogger logger, IEnumerable repositories, ISet availablePackages)" +returns = "Task" +file = "NuGetManager.cs" +static = true + +[[methods]] +parent = "NuGetManager" +name = "BackupPackageAsync" +sig = "Task BackupPackageAsync(PackageIdentity package, DirectoryInfo backupDirectory, int allPackagesCount, ISettings settings, DownloadResource downloadResource, SourceCacheContext cacheContext, CancellationToken token)" +returns = "Task" +file = "NuGetManager.cs" + +[[methods]] +parent = "NuGetManager" +name = "RestorePackageByIdAsync" +sig = "Task<(DownloadResourceResult result, bool isSuccess)> RestorePackageByIdAsync( string packageId, bool includePrerelease = false, bool includeUnlisted = false, CancellationToken token = default)" +returns = "Task<(DownloadResourceResult result, bool isSuccess)>" +file = "NuGetManager.cs" + +[[methods]] +parent = "NuGetManager" +name = "UnlistAllPackageVersionsAsync" +sig = "Task UnlistAllPackageVersionsAsync(string packageId, PackageMetadataResource packageMetadataResource, SourceCacheContext sourceCacheContext, string apiKey)" +returns = "Task" +file = "NuGetManager.cs" + +[[methods]] +parent = "NuGetManager" +name = "DeletePackageAsync" +sig = "Task DeletePackageAsync(PackageSearchMetadataRegistration pkgToDel, string apiKey)" +returns = "Task" +file = "NuGetManager.cs" + +[[methods]] +parent = "NuGetManager" +name = "RestorePackageAsync" +sig = "Task<(DownloadResourceResult result, bool isSuccess)> RestorePackageAsync( PackageIdentity pkgToRestore, DownloadResource downloadResource, SourceCacheContext sourceCacheContext, ISettings settings, bool directDownload = false, string directDownloadDirectory = null)" +returns = "Task<(DownloadResourceResult result, bool isSuccess)>" +file = "NuGetManager.cs" + +[[methods]] +parent = "NuGetManager" +name = "GetNuGetsToPublishOnNuGetOrgAsync" +sig = "Task GetNuGetsToPublishOnNuGetOrgAsync(FileInfo[] allNuGets, HashSet excludedPackageNames = null, params string[] packagesToPublish)" +returns = "Task" +file = "NuGetManager.cs" + +[[methods]] +parent = "NuGetManager" +name = "GetNuGetsToPublishAsync" +sig = "Task GetNuGetsToPublishAsync(PackageMetadataResource packageMetadataResource, FileInfo[] allNuGets, HashSet excludedPackageNames = null, params string[] packagesToPublish)" +returns = "Task" +file = "NuGetManager.cs" + +[[methods]] +parent = "NuGetManager" +name = "OnInitializeAsync" +sig = "Task OnInitializeAsync()" +returns = "Task" +file = "NuGetManager.cs" + [[classes]] name = "NuGetPackageInstallation" ns = "FEx.NuGetx" base = "NotifyPropertyChanged" file = "NuGetPackageInstallation.cs" +[[properties]] +parent = "NuGetPackageInstallation" +name = "Name" +sig = "string Name { get; }" +returns = "string" +file = "NuGetPackageInstallation.cs" + +[[properties]] +parent = "NuGetPackageInstallation" +name = "Version" +sig = "string Version { get; }" +returns = "string" +file = "NuGetPackageInstallation.cs" + +[[properties]] +parent = "NuGetPackageInstallation" +name = "Url" +sig = "Uri Url { get; }" +returns = "Uri" +file = "NuGetPackageInstallation.cs" + +[[ctors]] +parent = "NuGetPackageInstallation" +sig = "NuGetPackageInstallation(PackageIdentity package)" +file = "NuGetPackageInstallation.cs" + diff --git a/.api-surface/FEx/OneDrv.Abstractions.toml b/.api-surface/FEx/OneDrv.Abstractions.toml index 94cf8c23..67ed4b96 100644 --- a/.api-surface/FEx/OneDrv.Abstractions.toml +++ b/.api-surface/FEx/OneDrv.Abstractions.toml @@ -7,38 +7,241 @@ name = "IGraphServiceClientCache" ns = "FEx.OneDrv.Abstractions" file = "IGraphServiceClientCache.cs" +[[methods]] +parent = "IGraphServiceClientCache" +name = "GetAsync" +sig = "Task<(GraphServiceClient Client, string DriveId)> GetAsync(CancellationToken cancellationToken)" +returns = "Task<(GraphServiceClient Client, string DriveId)>" +file = "IGraphServiceClientCache.cs" + +[[methods]] +parent = "IGraphServiceClientCache" +name = "Invalidate" +sig = "void Invalidate()" +returns = "void" +file = "IGraphServiceClientCache.cs" + [[interfaces]] name = "IOneDriveAuthService" ns = "FEx.OneDrv.Abstractions" file = "IOneDriveAuthService.cs" +[[methods]] +parent = "IOneDriveAuthService" +name = "GetAccessTokenAsync" +sig = "Task GetAccessTokenAsync(CancellationToken cancellationToken)" +returns = "Task" +file = "IOneDriveAuthService.cs" + +[[methods]] +parent = "IOneDriveAuthService" +name = "SignOutAsync" +sig = "Task SignOutAsync(CancellationToken cancellationToken)" +returns = "Task" +file = "IOneDriveAuthService.cs" + [[interfaces]] name = "IOneDriveClient" ns = "FEx.OneDrv.Abstractions" file = "IOneDriveClient.cs" +[[methods]] +parent = "IOneDriveClient" +name = "ListFilesAsync" +sig = "Task> ListFilesAsync(string folderId, CancellationToken cancellationToken)" +returns = "Task>" +file = "IOneDriveClient.cs" + +[[methods]] +parent = "IOneDriveClient" +name = "GetFileAsync" +sig = "Task GetFileAsync(string itemId, CancellationToken cancellationToken)" +returns = "Task" +file = "IOneDriveClient.cs" + +[[methods]] +parent = "IOneDriveClient" +name = "ListFoldersAsync" +sig = "Task> ListFoldersAsync(string folderId, CancellationToken cancellationToken)" +returns = "Task>" +file = "IOneDriveClient.cs" + [[interfaces]] name = "IOneDriveFile" ns = "FEx.OneDrv.Abstractions" file = "IOneDriveFile.cs" +[[properties]] +parent = "IOneDriveFile" +name = "Id" +sig = "string Id { get; }" +returns = "string" +file = "IOneDriveFile.cs" + +[[properties]] +parent = "IOneDriveFile" +name = "Name" +sig = "string Name { get; }" +returns = "string" +file = "IOneDriveFile.cs" + +[[properties]] +parent = "IOneDriveFile" +name = "Path" +sig = "string Path { get; }" +returns = "string" +file = "IOneDriveFile.cs" + +[[properties]] +parent = "IOneDriveFile" +name = "Size" +sig = "long? Size { get; }" +returns = "long?" +file = "IOneDriveFile.cs" + +[[properties]] +parent = "IOneDriveFile" +name = "MimeType" +sig = "string MimeType { get; }" +returns = "string" +file = "IOneDriveFile.cs" + +[[properties]] +parent = "IOneDriveFile" +name = "QuickXorHash" +sig = "string QuickXorHash { get; }" +returns = "string" +file = "IOneDriveFile.cs" + +[[properties]] +parent = "IOneDriveFile" +name = "Sha256Hash" +sig = "string Sha256Hash { get; }" +returns = "string" +file = "IOneDriveFile.cs" + +[[properties]] +parent = "IOneDriveFile" +name = "LastModified" +sig = "DateTimeOffset? LastModified { get; }" +returns = "DateTimeOffset?" +file = "IOneDriveFile.cs" + +[[properties]] +parent = "IOneDriveFile" +name = "CreatedBy" +sig = "string CreatedBy { get; }" +returns = "string" +file = "IOneDriveFile.cs" + +[[properties]] +parent = "IOneDriveFile" +name = "ImageWidth" +sig = "int? ImageWidth { get; }" +returns = "int?" +file = "IOneDriveFile.cs" + +[[properties]] +parent = "IOneDriveFile" +name = "ImageHeight" +sig = "int? ImageHeight { get; }" +returns = "int?" +file = "IOneDriveFile.cs" + +[[properties]] +parent = "IOneDriveFile" +name = "VideoDurationMs" +sig = "int? VideoDurationMs { get; }" +returns = "int?" +file = "IOneDriveFile.cs" + [[interfaces]] name = "IOneDriveFolder" ns = "FEx.OneDrv.Abstractions" file = "IOneDriveFolder.cs" +[[properties]] +parent = "IOneDriveFolder" +name = "Id" +sig = "string Id { get; }" +returns = "string" +file = "IOneDriveFolder.cs" + +[[properties]] +parent = "IOneDriveFolder" +name = "Name" +sig = "string Name { get; }" +returns = "string" +file = "IOneDriveFolder.cs" + +[[properties]] +parent = "IOneDriveFolder" +name = "Path" +sig = "string Path { get; }" +returns = "string" +file = "IOneDriveFolder.cs" + +[[properties]] +parent = "IOneDriveFolder" +name = "ChildCount" +sig = "int? ChildCount { get; }" +returns = "int?" +file = "IOneDriveFolder.cs" + [[interfaces]] name = "IOneDriveItemEnumerator" ns = "FEx.OneDrv.Abstractions" file = "IOneDriveItemEnumerator.cs" +[[methods]] +parent = "IOneDriveItemEnumerator" +name = "EnumerateFilesAsync" +sig = "IAsyncEnumerable EnumerateFilesAsync(string folderId, CancellationToken cancellationToken)" +returns = "IAsyncEnumerable" +file = "IOneDriveItemEnumerator.cs" + [[interfaces]] name = "IOneDriveThumbnailService" ns = "FEx.OneDrv.Abstractions" file = "IOneDriveThumbnailService.cs" +[[methods]] +parent = "IOneDriveThumbnailService" +name = "GetThumbnailAsync" +sig = "Task GetThumbnailAsync(string itemId, CancellationToken cancellationToken)" +returns = "Task" +file = "IOneDriveThumbnailService.cs" + [[classes]] name = "OneDriveOptions" ns = "FEx.OneDrv.Abstractions" file = "OneDriveOptions.cs" +[[properties]] +parent = "OneDriveOptions" +name = "ClientId" +sig = "string ClientId { get; set; }" +returns = "string" +file = "OneDriveOptions.cs" + +[[properties]] +parent = "OneDriveOptions" +name = "TenantId" +sig = "string TenantId { get; set; }" +returns = "string" +file = "OneDriveOptions.cs" + +[[properties]] +parent = "OneDriveOptions" +name = "Scopes" +sig = "IList Scopes { get; set; }" +returns = "IList" +file = "OneDriveOptions.cs" + +[[properties]] +parent = "OneDriveOptions" +name = "TokenCachePath" +sig = "string TokenCachePath { get; set; }" +returns = "string" +file = "OneDriveOptions.cs" + diff --git a/.api-surface/FEx/OneDrv.Tests.toml b/.api-surface/FEx/OneDrv.Tests.toml index 5cab6686..5560bf23 100644 --- a/.api-surface/FEx/OneDrv.Tests.toml +++ b/.api-surface/FEx/OneDrv.Tests.toml @@ -7,23 +7,154 @@ name = "DriveItemMapperTests" ns = "FEx.OneDrv.Tests" file = "DriveItemMapperTests.cs" +[[methods]] +parent = "DriveItemMapperTests" +name = "MapFile_PopulatesAllFields_WhenFileMetadataPresent" +sig = "void MapFile_PopulatesAllFields_WhenFileMetadataPresent()" +returns = "void" +file = "DriveItemMapperTests.cs" + +[[methods]] +parent = "DriveItemMapperTests" +name = "MapFile_HandlesMissingOptionalFields" +sig = "void MapFile_HandlesMissingOptionalFields()" +returns = "void" +file = "DriveItemMapperTests.cs" + +[[methods]] +parent = "DriveItemMapperTests" +name = "MapFile_MapsVideoDurationToMilliseconds" +sig = "void MapFile_MapsVideoDurationToMilliseconds()" +returns = "void" +file = "DriveItemMapperTests.cs" + +[[methods]] +parent = "DriveItemMapperTests" +name = "MapFolder_PopulatesAllFields" +sig = "void MapFolder_PopulatesAllFields()" +returns = "void" +file = "DriveItemMapperTests.cs" + +[[methods]] +parent = "DriveItemMapperTests" +name = "MapFolder_HandlesNullChildCount" +sig = "void MapFolder_HandlesNullChildCount()" +returns = "void" +file = "DriveItemMapperTests.cs" + [[classes]] name = "GraphResiliencePipelineTests" ns = "FEx.OneDrv.Tests" file = "GraphResiliencePipelineTests.cs" +[[ctors]] +parent = "GraphResiliencePipelineTests" +sig = "GraphResiliencePipelineTests()" +file = "GraphResiliencePipelineTests.cs" + +[[methods]] +parent = "GraphResiliencePipelineTests" +name = "Pipeline_RetriesOn429RateLimit_UntilSuccess" +sig = "Task Pipeline_RetriesOn429RateLimit_UntilSuccess()" +returns = "Task" +file = "GraphResiliencePipelineTests.cs" + +[[methods]] +parent = "GraphResiliencePipelineTests" +name = "Pipeline_RetriesOn503Transient_UntilSuccess" +sig = "Task Pipeline_RetriesOn503Transient_UntilSuccess()" +returns = "Task" +file = "GraphResiliencePipelineTests.cs" + +[[methods]] +parent = "GraphResiliencePipelineTests" +name = "Pipeline_RetriesOnHttpRequestException" +sig = "Task Pipeline_RetriesOnHttpRequestException()" +returns = "Task" +file = "GraphResiliencePipelineTests.cs" + +[[methods]] +parent = "GraphResiliencePipelineTests" +name = "Pipeline_DoesNotRetryOn4xxOtherThan429" +sig = "Task Pipeline_DoesNotRetryOn4xxOtherThan429()" +returns = "Task" +file = "GraphResiliencePipelineTests.cs" + +[[methods]] +parent = "GraphResiliencePipelineTests" +name = "Pipeline_DoesNotRetryOnUnrelatedException" +sig = "Task Pipeline_DoesNotRetryOnUnrelatedException()" +returns = "Task" +file = "GraphResiliencePipelineTests.cs" + +[[methods]] +parent = "GraphResiliencePipelineTests" +name = "Pipeline_LogsWarningOnEachRetry" +sig = "Task Pipeline_LogsWarningOnEachRetry()" +returns = "Task" +file = "GraphResiliencePipelineTests.cs" + [[classes]] name = "GraphServiceClientCacheTests" ns = "FEx.OneDrv.Tests" file = "GraphServiceClientCacheTests.cs" +[[methods]] +parent = "GraphServiceClientCacheTests" +name = "GetAsync_CalledTwice_FactoriesInvokedOnce" +sig = "Task GetAsync_CalledTwice_FactoriesInvokedOnce()" +returns = "Task" +file = "GraphServiceClientCacheTests.cs" + +[[methods]] +parent = "GraphServiceClientCacheTests" +name = "Invalidate_AfterFirstGet_ForcesRebuildOnSecondGet" +sig = "Task Invalidate_AfterFirstGet_ForcesRebuildOnSecondGet()" +returns = "Task" +file = "GraphServiceClientCacheTests.cs" + +[[methods]] +parent = "GraphServiceClientCacheTests" +name = "GetAsync_ConcurrentCalls_BuildsClientOnce" +sig = "Task GetAsync_ConcurrentCalls_BuildsClientOnce()" +returns = "Task" +file = "GraphServiceClientCacheTests.cs" + +[[methods]] +parent = "GraphServiceClientCacheTests" +name = "Ctor_ThrowsOnNullAuth" +sig = "void Ctor_ThrowsOnNullAuth()" +returns = "void" +file = "GraphServiceClientCacheTests.cs" + [[classes]] name = "OneDriveOptionsTests" ns = "FEx.OneDrv.Tests" file = "OneDriveOptionsTests.cs" +[[methods]] +parent = "OneDriveOptionsTests" +name = "Defaults_TenantIsCommon_AndScopesIncludeFilesRead" +sig = "void Defaults_TenantIsCommon_AndScopesIncludeFilesRead()" +returns = "void" +file = "OneDriveOptionsTests.cs" + [[classes]] name = "OneDrvServiceCollectionExtensionsTests" ns = "FEx.OneDrv.Tests" file = "OneDrvServiceCollectionExtensionsTests.cs" +[[methods]] +parent = "OneDrvServiceCollectionExtensionsTests" +name = "AddOneDrv_RegistersAllPublicServices" +sig = "void AddOneDrv_RegistersAllPublicServices()" +returns = "void" +file = "OneDrvServiceCollectionExtensionsTests.cs" + +[[methods]] +parent = "OneDrvServiceCollectionExtensionsTests" +name = "AddOneDrv_RegistersServicesAsSingletons" +sig = "void AddOneDrv_RegistersServicesAsSingletons()" +returns = "void" +file = "OneDrvServiceCollectionExtensionsTests.cs" + diff --git a/.api-surface/FEx/OneDrv.toml b/.api-surface/FEx/OneDrv.toml index 0e0d8e50..fa278fbe 100644 --- a/.api-surface/FEx/OneDrv.toml +++ b/.api-surface/FEx/OneDrv.toml @@ -8,16 +8,30 @@ ns = "FEx.OneDrv" base = "InitializeOnlyModule" file = "FExOneDrvModule.cs" +[[ctors]] +parent = "FExOneDrvModule" +sig = "FExOneDrvModule(OneDriveOptions options)" +file = "FExOneDrvModule.cs" + +[[methods]] +parent = "FExOneDrvModule" +name = "RegisterServices" +sig = "void RegisterServices(object container, IServiceCollection services)" +returns = "void" +file = "FExOneDrvModule.cs" + [[classes]] name = "GraphResiliencePipeline" ns = "FEx.OneDrv" file = "GraphResiliencePipeline.cs" static = true -[[classes]] -name = "IsExternalInit" -ns = "System.Runtime.CompilerServices" -file = "IsExternalInit.cs" +[[methods]] +parent = "GraphResiliencePipeline" +name = "Create" +sig = "static ResiliencePipeline Create(IFExLogger logger)" +returns = "ResiliencePipeline" +file = "GraphResiliencePipeline.cs" static = true [[classes]] @@ -26,24 +40,93 @@ ns = "FEx.OneDrv" base = "IOneDriveAuthService" file = "MsalAuthService.cs" +[[ctors]] +parent = "MsalAuthService" +sig = "MsalAuthService(OneDriveOptions options, IFExLogger logger)" +file = "MsalAuthService.cs" + +[[methods]] +parent = "MsalAuthService" +name = "GetAccessTokenAsync" +sig = "Task GetAccessTokenAsync(CancellationToken cancellationToken)" +returns = "Task" +file = "MsalAuthService.cs" + +[[methods]] +parent = "MsalAuthService" +name = "SignOutAsync" +sig = "Task SignOutAsync(CancellationToken cancellationToken)" +returns = "Task" +file = "MsalAuthService.cs" + [[classes]] name = "OneDriveClient" ns = "FEx.OneDrv" base = "IOneDriveClient" file = "OneDriveClient.cs" +[[ctors]] +parent = "OneDriveClient" +sig = "OneDriveClient(IGraphServiceClientCache graphCache, IFExLogger logger)" +file = "OneDriveClient.cs" + +[[methods]] +parent = "OneDriveClient" +name = "ListFilesAsync" +sig = "Task> ListFilesAsync(string folderId, CancellationToken cancellationToken)" +returns = "Task>" +file = "OneDriveClient.cs" + +[[methods]] +parent = "OneDriveClient" +name = "GetFileAsync" +sig = "Task GetFileAsync(string itemId, CancellationToken cancellationToken)" +returns = "Task" +file = "OneDriveClient.cs" + +[[methods]] +parent = "OneDriveClient" +name = "ListFoldersAsync" +sig = "Task> ListFoldersAsync(string folderId, CancellationToken cancellationToken)" +returns = "Task>" +file = "OneDriveClient.cs" + [[classes]] name = "OneDriveItemEnumerator" ns = "FEx.OneDrv" base = "IOneDriveItemEnumerator" file = "OneDriveItemEnumerator.cs" +[[ctors]] +parent = "OneDriveItemEnumerator" +sig = "OneDriveItemEnumerator(IGraphServiceClientCache graphCache, IFExLogger logger)" +file = "OneDriveItemEnumerator.cs" + +[[methods]] +parent = "OneDriveItemEnumerator" +name = "EnumerateFilesAsync" +sig = "IAsyncEnumerable EnumerateFilesAsync(string folderId, [EnumeratorCancellation] CancellationToken cancellationToken)" +returns = "IAsyncEnumerable" +file = "OneDriveItemEnumerator.cs" + [[classes]] name = "OneDriveThumbnailService" ns = "FEx.OneDrv" base = "IOneDriveThumbnailService" file = "OneDriveThumbnailService.cs" +[[ctors]] +parent = "OneDriveThumbnailService" +sig = "OneDriveThumbnailService(IGraphServiceClientCache graphCache, OneDriveOptions options, IFExLogger logger)" +file = "OneDriveThumbnailService.cs" + +[[methods]] +parent = "OneDriveThumbnailService" +name = "GetThumbnailAsync" +sig = "Task GetThumbnailAsync(string itemId, CancellationToken cancellationToken)" +returns = "Task" +file = "OneDriveThumbnailService.cs" + [[classes]] name = "OneDrvServiceCollectionExtensions" ns = "FEx.OneDrv" @@ -52,8 +135,8 @@ static = true [[extensions]] name = "AddOneDrv" -sig = "IServiceCollection AddOneDrv(this IServiceCollection services, OneDriveOptions options)" returns = "IServiceCollection" +sig = "IServiceCollection AddOneDrv(this IServiceCollection services, OneDriveOptions options)" file = "OneDrvServiceCollectionExtensions.cs" [[classes]] @@ -62,27 +145,205 @@ ns = "FEx.OneDrv.Auth" base = "IAccessTokenProvider" file = "Auth\\DelegatingAccessTokenProvider.cs" +[[properties]] +parent = "DelegatingAccessTokenProvider" +name = "AllowedHostsValidator" +sig = "AllowedHostsValidator AllowedHostsValidator { get; }" +returns = "AllowedHostsValidator" +file = "Auth\\DelegatingAccessTokenProvider.cs" + +[[ctors]] +parent = "DelegatingAccessTokenProvider" +sig = "DelegatingAccessTokenProvider(Func> tokenFactory)" +file = "Auth\\DelegatingAccessTokenProvider.cs" + +[[methods]] +parent = "DelegatingAccessTokenProvider" +name = "GetAuthorizationTokenAsync" +sig = "Task GetAuthorizationTokenAsync(Uri uri, Dictionary additionalAuthenticationContext, CancellationToken cancellationToken)" +returns = "Task" +file = "Auth\\DelegatingAccessTokenProvider.cs" + [[classes]] name = "GraphServiceClientCache" ns = "FEx.OneDrv.Auth" base = "IGraphServiceClientCache, IDisposable" file = "Auth\\GraphServiceClientCache.cs" +[[ctors]] +parent = "GraphServiceClientCache" +sig = "GraphServiceClientCache(IOneDriveAuthService auth)" +file = "Auth\\GraphServiceClientCache.cs" + +[[ctors]] +parent = "GraphServiceClientCache" +sig = "GraphServiceClientCache(IOneDriveAuthService auth, Func clientFactory, Func> driveIdFactory)" +file = "Auth\\GraphServiceClientCache.cs" + +[[methods]] +parent = "GraphServiceClientCache" +name = "GetAsync" +sig = "Task<(GraphServiceClient Client, string DriveId)> GetAsync(CancellationToken cancellationToken)" +returns = "Task<(GraphServiceClient Client, string DriveId)>" +file = "Auth\\GraphServiceClientCache.cs" + +[[methods]] +parent = "GraphServiceClientCache" +name = "Invalidate" +sig = "void Invalidate()" +returns = "void" +file = "Auth\\GraphServiceClientCache.cs" + +[[methods]] +parent = "GraphServiceClientCache" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Auth\\GraphServiceClientCache.cs" + [[classes]] name = "DriveItemMapper" ns = "FEx.OneDrv.Models" file = "Models\\DriveItemMapper.cs" static = true +[[methods]] +parent = "DriveItemMapper" +name = "MapFile" +sig = "static IOneDriveFile MapFile(DriveItem item)" +returns = "IOneDriveFile" +file = "Models\\DriveItemMapper.cs" +static = true + +[[methods]] +parent = "DriveItemMapper" +name = "MapFolder" +sig = "static IOneDriveFolder MapFolder(DriveItem item)" +returns = "IOneDriveFolder" +file = "Models\\DriveItemMapper.cs" +static = true + [[classes]] name = "OneDriveFile" ns = "FEx.OneDrv.Models" base = "IOneDriveFile" file = "Models\\OneDriveFile.cs" +[[properties]] +parent = "OneDriveFile" +name = "Id" +sig = "string Id { get; init; }" +returns = "string" +file = "Models\\OneDriveFile.cs" + +[[properties]] +parent = "OneDriveFile" +name = "Name" +sig = "string Name { get; init; }" +returns = "string" +file = "Models\\OneDriveFile.cs" + +[[properties]] +parent = "OneDriveFile" +name = "Path" +sig = "string Path { get; init; }" +returns = "string" +file = "Models\\OneDriveFile.cs" + +[[properties]] +parent = "OneDriveFile" +name = "Size" +sig = "long? Size { get; init; }" +returns = "long?" +file = "Models\\OneDriveFile.cs" + +[[properties]] +parent = "OneDriveFile" +name = "MimeType" +sig = "string MimeType { get; init; }" +returns = "string" +file = "Models\\OneDriveFile.cs" + +[[properties]] +parent = "OneDriveFile" +name = "QuickXorHash" +sig = "string QuickXorHash { get; init; }" +returns = "string" +file = "Models\\OneDriveFile.cs" + +[[properties]] +parent = "OneDriveFile" +name = "Sha256Hash" +sig = "string Sha256Hash { get; init; }" +returns = "string" +file = "Models\\OneDriveFile.cs" + +[[properties]] +parent = "OneDriveFile" +name = "LastModified" +sig = "DateTimeOffset? LastModified { get; init; }" +returns = "DateTimeOffset?" +file = "Models\\OneDriveFile.cs" + +[[properties]] +parent = "OneDriveFile" +name = "CreatedBy" +sig = "string CreatedBy { get; init; }" +returns = "string" +file = "Models\\OneDriveFile.cs" + +[[properties]] +parent = "OneDriveFile" +name = "ImageWidth" +sig = "int? ImageWidth { get; init; }" +returns = "int?" +file = "Models\\OneDriveFile.cs" + +[[properties]] +parent = "OneDriveFile" +name = "ImageHeight" +sig = "int? ImageHeight { get; init; }" +returns = "int?" +file = "Models\\OneDriveFile.cs" + +[[properties]] +parent = "OneDriveFile" +name = "VideoDurationMs" +sig = "int? VideoDurationMs { get; init; }" +returns = "int?" +file = "Models\\OneDriveFile.cs" + [[classes]] name = "OneDriveFolder" ns = "FEx.OneDrv.Models" base = "IOneDriveFolder" file = "Models\\OneDriveFolder.cs" +[[properties]] +parent = "OneDriveFolder" +name = "Id" +sig = "string Id { get; init; }" +returns = "string" +file = "Models\\OneDriveFolder.cs" + +[[properties]] +parent = "OneDriveFolder" +name = "Name" +sig = "string Name { get; init; }" +returns = "string" +file = "Models\\OneDriveFolder.cs" + +[[properties]] +parent = "OneDriveFolder" +name = "Path" +sig = "string Path { get; init; }" +returns = "string" +file = "Models\\OneDriveFolder.cs" + +[[properties]] +parent = "OneDriveFolder" +name = "ChildCount" +sig = "int? ChildCount { get; init; }" +returns = "int?" +file = "Models\\OneDriveFolder.cs" + diff --git a/.api-surface/FEx/PersistentStorage.Abstractions.toml b/.api-surface/FEx/PersistentStorage.Abstractions.toml index 32afcef2..11bfcbc2 100644 --- a/.api-surface/FEx/PersistentStorage.Abstractions.toml +++ b/.api-surface/FEx/PersistentStorage.Abstractions.toml @@ -8,14 +8,145 @@ ns = "FEx.PersistentStorage.Abstractions" base = "ICacheableItem" file = "CacheableItem.cs" +[[properties]] +parent = "CacheableItem" +name = "LocalStorageId" +sig = "ObjectId LocalStorageId { get; set; }" +returns = "ObjectId" +file = "CacheableItem.cs" + +[[properties]] +parent = "CacheableItem" +name = "TimeStamp" +sig = "DateTime TimeStamp { get; set; }" +returns = "DateTime" +file = "CacheableItem.cs" + +[[ctors]] +parent = "CacheableItem" +sig = "CacheableItem()" +file = "CacheableItem.cs" + [[interfaces]] name = "ICacheableItem" ns = "FEx.PersistentStorage.Abstractions" file = "ICacheableItem.cs" +[[properties]] +parent = "ICacheableItem" +name = "LocalStorageId" +sig = "ObjectId LocalStorageId { get; }" +returns = "ObjectId" +file = "ICacheableItem.cs" + [[interfaces]] name = "ICacheService" ns = "FEx.PersistentStorage.Abstractions" +base = "IFileLocalStorageService" +file = "ICacheService.cs" + +[[methods]] +parent = "ICacheService" +name = "Add" +sig = "BsonValue Add(T item) where T : ICacheableItem" +returns = "BsonValue" +summary = "Caches object" +file = "ICacheService.cs" + +[[methods]] +parent = "ICacheService" +name = "Add" +sig = "void Add(IEnumerable items) where T : ICacheableItem" +returns = "void" +summary = "Caches the range of objects" +file = "ICacheService.cs" + +[[methods]] +parent = "ICacheService" +name = "Update" +sig = "bool Update(T item) where T : ICacheableItem" +returns = "bool" +summary = "Updates an existing object. May remove the entire collection." +file = "ICacheService.cs" + +[[methods]] +parent = "ICacheService" +name = "Upsert" +sig = "bool Upsert(T item, Expression> predicate) where T : ICacheableItem" +returns = "bool" +summary = "Insert or Update object based on _id key or predicate." +file = "ICacheService.cs" + +[[methods]] +parent = "ICacheService" +name = "Upsert" +sig = "void Upsert(IEnumerable items, Expression> predicate) where T : ICacheableItem" +returns = "void" +summary = "Insert or Update objects based on _id key or predicate." +file = "ICacheService.cs" + +[[methods]] +parent = "ICacheService" +name = "Delete" +sig = "bool Delete(ObjectId id) where T : ICacheableItem" +returns = "bool" +summary = "Removes cached object of specified type" +file = "ICacheService.cs" + +[[methods]] +parent = "ICacheService" +name = "Delete" +sig = "bool Delete(IEnumerable items) where T : ICacheableItem" +returns = "bool" +summary = "Removes cached objects" +file = "ICacheService.cs" + +[[methods]] +parent = "ICacheService" +name = "Delete" +sig = "bool Delete(Expression> predicate) where T : ICacheableItem" +returns = "bool" +summary = "Removes cached objects that meet criteria of the predicate" +file = "ICacheService.cs" + +[[methods]] +parent = "ICacheService" +name = "FirstOrDefault" +sig = "T FirstOrDefault(Expression> predicate) where T : ICacheableItem" +returns = "T" +summary = "Tries to find an object in cache that meets the requirements of the predicate" +file = "ICacheService.cs" + +[[methods]] +parent = "ICacheService" +name = "Get" +sig = "IReadOnlyCollection Get(Expression> predicate) where T : ICacheableItem" +returns = "IReadOnlyCollection" +summary = "The entire collection of cached objects of specified type matching predicate or all of them if predicate is null." +file = "ICacheService.cs" + +[[methods]] +parent = "ICacheService" +name = "ReplaceWith" +sig = "void ReplaceWith(IEnumerable items) where T : ICacheableItem" +returns = "void" +summary = "Deletes all items in provided items collection and replaces it with that items" +file = "ICacheService.cs" + +[[methods]] +parent = "ICacheService" +name = "ReplaceWith" +sig = "BsonValue ReplaceWith(T item) where T : ICacheableItem" +returns = "BsonValue" +summary = "Deletes all items in provided item collection and replaces it with that single item" +file = "ICacheService.cs" + +[[methods]] +parent = "ICacheService" +name = "ClearCache" +sig = "void ClearCache(ClearCacheReason clearCacheReason)" +returns = "void" +summary = "Calls the ClearCache method of inheritors of IClearCache for the selected Cached Type" file = "ICacheService.cs" [[interfaces]] @@ -23,29 +154,165 @@ name = "IClearCache" ns = "FEx.PersistentStorage.Abstractions" file = "IClearCache.cs" +[[properties]] +parent = "IClearCache" +name = "ClearCacheReason" +sig = "ClearCacheReason ClearCacheReason { get; }" +returns = "ClearCacheReason" +file = "IClearCache.cs" + +[[properties]] +parent = "IClearCache" +name = "ClearCachePriority" +sig = "ClearCachePriority ClearCachePriority { get; }" +returns = "ClearCachePriority" +file = "IClearCache.cs" + +[[methods]] +parent = "IClearCache" +name = "ClearCache" +sig = "void ClearCache()" +returns = "void" +file = "IClearCache.cs" + [[interfaces]] name = "IDatabaseFilePathResolver" ns = "FEx.PersistentStorage.Abstractions" file = "IDatabaseFilePathResolver.cs" +[[methods]] +parent = "IDatabaseFilePathResolver" +name = "GetDatabasesFolderPath" +sig = "string GetDatabasesFolderPath()" +returns = "string" +file = "IDatabaseFilePathResolver.cs" + [[interfaces]] name = "IDatabaseProvider" ns = "FEx.PersistentStorage.Abstractions" file = "IDatabaseProvider.cs" +[[properties]] +parent = "IDatabaseProvider" +name = "Repository" +sig = "ILiteRepository Repository { get; }" +returns = "ILiteRepository" +file = "IDatabaseProvider.cs" + +[[properties]] +parent = "IDatabaseProvider" +name = "DbLock" +sig = "ExtendedReaderWriterLockSlim DbLock { get; }" +returns = "ExtendedReaderWriterLockSlim" +file = "IDatabaseProvider.cs" + [[interfaces]] name = "IFExCachedFile" ns = "FEx.PersistentStorage.Abstractions" +base = "IDisposable" +file = "IFExCachedFile.cs" + +[[properties]] +parent = "IFExCachedFile" +name = "Timestamp" +sig = "DateTime Timestamp { get; }" +returns = "DateTime" +file = "IFExCachedFile.cs" + +[[properties]] +parent = "IFExCachedFile" +name = "IsExpired" +sig = "bool IsExpired { get; }" +returns = "bool" +file = "IFExCachedFile.cs" + +[[properties]] +parent = "IFExCachedFile" +name = "Filename" +sig = "string Filename { get; }" +returns = "string" +file = "IFExCachedFile.cs" + +[[properties]] +parent = "IFExCachedFile" +name = "IsDownloading" +sig = "bool IsDownloading { get; set; }" +returns = "bool" +file = "IFExCachedFile.cs" + +[[properties]] +parent = "IFExCachedFile" +name = "Url" +sig = "Uri Url { get; }" +returns = "Uri" +file = "IFExCachedFile.cs" + +[[properties]] +parent = "IFExCachedFile" +name = "Id" +sig = "string Id { get; }" +returns = "string" +file = "IFExCachedFile.cs" + +[[methods]] +parent = "IFExCachedFile" +name = "UpdateData" +sig = "void UpdateData(IFExCachedFile data)" +returns = "void" +file = "IFExCachedFile.cs" + +[[methods]] +parent = "IFExCachedFile" +name = "GetDataStream" +sig = "MemoryStream GetDataStream()" +returns = "MemoryStream" +file = "IFExCachedFile.cs" + +[[methods]] +parent = "IFExCachedFile" +name = "GetDataStreamAsync" +sig = "Task GetDataStreamAsync(CancellationToken cancellationToken)" +returns = "Task" file = "IFExCachedFile.cs" [[interfaces]] name = "IFExDownloadResult" ns = "FEx.PersistentStorage.Abstractions" +base = "IDisposable" +file = "IFExDownloadResult.cs" + +[[properties]] +parent = "IFExDownloadResult" +name = "Url" +sig = "Uri Url { get; }" +returns = "Uri" +file = "IFExDownloadResult.cs" + +[[properties]] +parent = "IFExDownloadResult" +name = "FileName" +sig = "string FileName { get; }" +returns = "string" +file = "IFExDownloadResult.cs" + +[[methods]] +parent = "IFExDownloadResult" +name = "UseDataStream" +sig = "void UseDataStream(Action streamAction)" +returns = "void" +file = "IFExDownloadResult.cs" + +[[methods]] +parent = "IFExDownloadResult" +name = "UseDataStream" +sig = "T UseDataStream(Func streamAction)" +returns = "T" file = "IFExDownloadResult.cs" [[interfaces]] name = "IFExPersistentStorageContainer" ns = "FEx.PersistentStorage.Abstractions" +base = "IContainer, IContainer, IContainer, IContainer" file = "IFExPersistencyStorageContainer.cs" [[interfaces]] @@ -53,9 +320,138 @@ name = "IFileLocalStorageService" ns = "FEx.PersistentStorage.Abstractions" file = "IFileLocalStorageService.cs" +[[methods]] +parent = "IFileLocalStorageService" +name = "CacheFile" +sig = "IFExCachedFile CacheFile(IFExDownloadResult downloadResult)" +returns = "IFExCachedFile" +summary = "Cache file stream" +file = "IFileLocalStorageService.cs" + +[[methods]] +parent = "IFileLocalStorageService" +name = "GetCachedFile" +sig = "IFExCachedFile GetCachedFile(Uri fileUrl)" +returns = "IFExCachedFile" +summary = "Find cached file for provided download URL" +file = "IFileLocalStorageService.cs" + +[[methods]] +parent = "IFileLocalStorageService" +name = "UpdateFile" +sig = "void UpdateFile(IFExCachedFile cachedFile)" +returns = "void" +summary = "Overwrite cached file with new value" +file = "IFileLocalStorageService.cs" + +[[methods]] +parent = "IFileLocalStorageService" +name = "DeleteExpiredFiles" +sig = "void DeleteExpiredFiles()" +returns = "void" +summary = "Delete all outdated files from cache" +file = "IFileLocalStorageService.cs" + [[interfaces]] name = "ILocalStorageService" ns = "FEx.PersistentStorage.Abstractions" +base = "IFileLocalStorageService" +file = "ILocalStorageService.cs" + +[[methods]] +parent = "ILocalStorageService" +name = "GetAll" +sig = "IReadOnlyList GetAll(Expression> predicate) where T : ICacheableItem" +returns = "IReadOnlyList" +summary = "Returns all objects, or only those matching predicate, inside collection ordered by _id index." +file = "ILocalStorageService.cs" + +[[methods]] +parent = "ILocalStorageService" +name = "FirstOrDefault" +sig = "T FirstOrDefault(Expression> predicate) where T : ICacheableItem" +returns = "T" +summary = "Returns first object of collection or null if there are no results of query" +file = "ILocalStorageService.cs" + +[[methods]] +parent = "ILocalStorageService" +name = "Insert" +sig = "BsonValue Insert(T item) where T : ICacheableItem" +returns = "BsonValue" +summary = "Insert a new object into collection." +file = "ILocalStorageService.cs" + +[[methods]] +parent = "ILocalStorageService" +name = "Insert" +sig = "void Insert(IEnumerable items) where T : ICacheableItem" +returns = "void" +summary = "Insert an array of new objects into collection." +file = "ILocalStorageService.cs" + +[[methods]] +parent = "ILocalStorageService" +name = "Update" +sig = "bool Update(T item) where T : ICacheableItem" +returns = "bool" +summary = "Update object into collection." +file = "ILocalStorageService.cs" + +[[methods]] +parent = "ILocalStorageService" +name = "Upsert" +sig = "bool Upsert(T item, Expression> predicate) where T : ICacheableItem" +returns = "bool" +summary = "Insert or Update object based on _id key or predicate." +file = "ILocalStorageService.cs" + +[[methods]] +parent = "ILocalStorageService" +name = "Upsert" +sig = "void Upsert(IEnumerable items, Expression> predicate) where T : ICacheableItem" +returns = "void" +summary = "Insert or Update objects based on _id key or predicate." +file = "ILocalStorageService.cs" + +[[methods]] +parent = "ILocalStorageService" +name = "Delete" +sig = "bool Delete(ObjectId id) where T : ICacheableItem" +returns = "bool" +summary = "Delete entity based on _id key" +file = "ILocalStorageService.cs" + +[[methods]] +parent = "ILocalStorageService" +name = "Delete" +sig = "bool Delete(IEnumerable items) where T : ICacheableItem" +returns = "bool" +summary = "Deletes entities based on their _id key" +file = "ILocalStorageService.cs" + +[[methods]] +parent = "ILocalStorageService" +name = "DeleteAll" +sig = "bool DeleteAll(Expression> predicate) where T : ICacheableItem" +returns = "bool" +summary = "Delete entity based on predicate filter expression" +file = "ILocalStorageService.cs" + +[[methods]] +parent = "ILocalStorageService" +name = "ReplaceWith" +sig = "void ReplaceWith(IEnumerable items) where T : ICacheableItem" +returns = "void" +summary = "Deletes all items in provided items collection and replaces it with that items" +file = "ILocalStorageService.cs" + +[[methods]] +parent = "ILocalStorageService" +name = "ReplaceWith" +sig = "BsonValue ReplaceWith(T item) where T : ICacheableItem" +returns = "BsonValue" +summary = "Deletes all items in provided item collection and replaces it with that single item" file = "ILocalStorageService.cs" [[classes]] @@ -64,6 +460,14 @@ ns = "FEx.PersistentStorage.Abstractions.Configuration" file = "Configuration\\CacheServiceConfiguration.cs" static = true +[[properties]] +parent = "CacheServiceConfiguration" +name = "ExpirationTimeSpan" +sig = "static TimeSpan ExpirationTimeSpan { get; set; }" +returns = "TimeSpan" +file = "Configuration\\CacheServiceConfiguration.cs" +static = true + [[enums]] name = "ClearCachePriority" ns = "FEx.PersistentStorage.Abstractions.Enums" @@ -82,9 +486,33 @@ static = true [[extensions]] name = "IsExpired" +returns = "bool" sig = "bool IsExpired(this LiteFileInfo file)" +file = "Extensions\\CachedFileExtensions.cs" + +[[methods]] +parent = "CachedFileExtensions" +name = "IsExpired" +sig = "static bool IsExpired(DateTime timestamp)" returns = "bool" file = "Extensions\\CachedFileExtensions.cs" +static = true + +[[methods]] +parent = "CachedFileExtensions" +name = "GetFileId" +sig = "static string GetFileId(Uri fileUrl)" +returns = "string" +file = "Extensions\\CachedFileExtensions.cs" +static = true + +[[methods]] +parent = "CachedFileExtensions" +name = "GetIsExpiredPredicate" +sig = "static Expression, bool>> GetIsExpiredPredicate()" +returns = "Expression, bool>>" +file = "Extensions\\CachedFileExtensions.cs" +static = true [[classes]] name = "CacheServiceExtensions" @@ -92,6 +520,36 @@ ns = "FEx.PersistentStorage.Abstractions.Extensions" file = "Extensions\\CacheServiceExtensions.cs" static = true +[[extensions]] +name = "Upsert" +returns = "bool" +sig = "bool Upsert(this ICacheService service, T item)" +file = "Extensions\\CacheServiceExtensions.cs" + +[[extensions]] +name = "Upsert" +returns = "void" +sig = "void Upsert(this ICacheService service, IEnumerable items)" +file = "Extensions\\CacheServiceExtensions.cs" + +[[extensions]] +name = "Delete" +returns = "bool" +sig = "bool Delete(this ICacheService service)" +file = "Extensions\\CacheServiceExtensions.cs" + +[[extensions]] +name = "FirstOrDefault" +returns = "T" +sig = "T FirstOrDefault(this ICacheService service)" +file = "Extensions\\CacheServiceExtensions.cs" + +[[extensions]] +name = "Get" +returns = "IReadOnlyCollection" +sig = "IReadOnlyCollection Get(this ICacheService service)" +file = "Extensions\\CacheServiceExtensions.cs" + [[classes]] name = "ClearCacheReasonExtensions" ns = "FEx.PersistentStorage.Abstractions.Extensions" @@ -100,8 +558,8 @@ static = true [[extensions]] name = "HasFlagFast" -sig = "bool HasFlagFast(this ClearCacheReason value, ClearCacheReason flag)" returns = "bool" +sig = "bool HasFlagFast(this ClearCacheReason value, ClearCacheReason flag)" file = "Extensions\\ClearCacheReasonExtensions.cs" [[classes]] @@ -110,9 +568,145 @@ ns = "FEx.PersistentStorage.Abstractions.Extensions" file = "Extensions\\LocalStorageServiceExtensions.cs" static = true +[[extensions]] +name = "GetAll" +returns = "IReadOnlyList" +sig = "IReadOnlyList GetAll(this ILocalStorageService service)" +file = "Extensions\\LocalStorageServiceExtensions.cs" + +[[extensions]] +name = "FirstOrDefault" +returns = "T" +sig = "T FirstOrDefault(this ILocalStorageService service)" +file = "Extensions\\LocalStorageServiceExtensions.cs" + +[[extensions]] +name = "Upsert" +returns = "bool" +sig = "bool Upsert(this ILocalStorageService service, T item)" +file = "Extensions\\LocalStorageServiceExtensions.cs" + +[[extensions]] +name = "Upsert" +returns = "void" +sig = "void Upsert(this ILocalStorageService service, IEnumerable items)" +file = "Extensions\\LocalStorageServiceExtensions.cs" + +[[extensions]] +name = "DeleteAll" +returns = "bool" +sig = "bool DeleteAll(this ILocalStorageService service)" +file = "Extensions\\LocalStorageServiceExtensions.cs" + [[classes]] name = "FExCachedFile" ns = "FEx.PersistentStorage.Abstractions.Models" base = "NotifyPropertyChanged, IFExCachedFile, IAsyncDisposable" file = "Models\\FExCachedFile.cs" +[[properties]] +parent = "FExCachedFile" +name = "Filename" +sig = "string Filename { get; }" +returns = "string" +file = "Models\\FExCachedFile.cs" + +[[properties]] +parent = "FExCachedFile" +name = "Timestamp" +sig = "DateTime Timestamp { get; }" +returns = "DateTime" +file = "Models\\FExCachedFile.cs" + +[[properties]] +parent = "FExCachedFile" +name = "IsExpired" +sig = "bool IsExpired { get; }" +returns = "bool" +file = "Models\\FExCachedFile.cs" + +[[properties]] +parent = "FExCachedFile" +name = "Url" +sig = "Uri Url { get; }" +returns = "Uri" +file = "Models\\FExCachedFile.cs" + +[[properties]] +parent = "FExCachedFile" +name = "Id" +sig = "string Id { get; }" +returns = "string" +file = "Models\\FExCachedFile.cs" + +[[properties]] +parent = "FExCachedFile" +name = "IsDownloading" +sig = "bool IsDownloading { get; set; }" +returns = "bool" +file = "Models\\FExCachedFile.cs" + +[[ctors]] +parent = "FExCachedFile" +sig = "FExCachedFile(LiteFileInfo file)" +file = "Models\\FExCachedFile.cs" + +[[ctors]] +parent = "FExCachedFile" +sig = "FExCachedFile(FileInfo file, Uri url)" +file = "Models\\FExCachedFile.cs" + +[[ctors]] +parent = "FExCachedFile" +sig = "FExCachedFile(IFExDownloadResult downloadResult)" +file = "Models\\FExCachedFile.cs" + +[[methods]] +parent = "FExCachedFile" +name = "UpdateData" +sig = "void UpdateData(IFExCachedFile data)" +returns = "void" +file = "Models\\FExCachedFile.cs" + +[[methods]] +parent = "FExCachedFile" +name = "GetDataStream" +sig = "MemoryStream GetDataStream()" +returns = "MemoryStream" +file = "Models\\FExCachedFile.cs" + +[[methods]] +parent = "FExCachedFile" +name = "GetDataStreamAsync" +sig = "Task GetDataStreamAsync(CancellationToken cancellationToken)" +returns = "Task" +file = "Models\\FExCachedFile.cs" + +[[methods]] +parent = "FExCachedFile" +name = "Dispose" +sig = "void Dispose(bool disposing)" +returns = "void" +file = "Models\\FExCachedFile.cs" + +[[methods]] +parent = "FExCachedFile" +name = "DisposeAsync" +sig = "ValueTask DisposeAsync(bool disposing)" +returns = "ValueTask" +file = "Models\\FExCachedFile.cs" + +[[methods]] +parent = "FExCachedFile" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Models\\FExCachedFile.cs" + +[[methods]] +parent = "FExCachedFile" +name = "DisposeAsync" +sig = "ValueTask DisposeAsync()" +returns = "ValueTask" +file = "Models\\FExCachedFile.cs" + diff --git a/.api-surface/FEx/PersistentStorage.Rx.toml b/.api-surface/FEx/PersistentStorage.Rx.toml index f1b1aed2..e534e85f 100644 --- a/.api-surface/FEx/PersistentStorage.Rx.toml +++ b/.api-surface/FEx/PersistentStorage.Rx.toml @@ -5,42 +5,202 @@ path = "src\\PersistentStorage.Rx" [[classes]] name = "AggregatedCollectionCachedSubject" ns = "FEx.PersistentStorage.Rx.Subjects" -base = "CollectionCachedSubject - where TCacheable : class, ICacheableItem" +base = "CollectionCachedSubject" +file = "Subjects\\AggregatedCollectionCachedSubject.cs" + +[[ctors]] +parent = "AggregatedCollectionCachedSubject" +sig = "AggregatedCollectionCachedSubject(ICacheService cacheService, ClearCacheReason clearCacheReason)" +file = "Subjects\\AggregatedCollectionCachedSubject.cs" + +[[methods]] +parent = "AggregatedCollectionCachedSubject" +name = "OnReset" +sig = "void OnReset(IEnumerable newCollection)" +returns = "void" +file = "Subjects\\AggregatedCollectionCachedSubject.cs" + +[[methods]] +parent = "AggregatedCollectionCachedSubject" +name = "OnNext" +sig = "void OnNext(IReadOnlyCollection value)" +returns = "void" file = "Subjects\\AggregatedCollectionCachedSubject.cs" [[classes]] name = "CachedSubjectBase" ns = "FEx.PersistentStorage.Rx.Subjects" -base = "FExBehaviorSubject, IClearCache, - IRequiresInitialization where TCacheable : class, ICacheableItem" +base = "FExBehaviorSubject, IClearCache, IRequiresInitialization" +file = "Subjects\\CachedSubjectBase.cs" + +[[properties]] +parent = "CachedSubjectBase" +name = "ClearCacheReason" +sig = "ClearCacheReason ClearCacheReason { get; }" +returns = "ClearCacheReason" +file = "Subjects\\CachedSubjectBase.cs" + +[[ctors]] +parent = "CachedSubjectBase" +sig = "CachedSubjectBase(ICacheService cacheService, ClearCacheReason clearCacheReason)" +file = "Subjects\\CachedSubjectBase.cs" + +[[ctors]] +parent = "CachedSubjectBase" +sig = "CachedSubjectBase(ICacheService cacheService, ClearCacheReason clearCacheReason, TData defaultValue)" +file = "Subjects\\CachedSubjectBase.cs" + +[[methods]] +parent = "CachedSubjectBase" +name = "ClearCache" +sig = "void ClearCache()" +returns = "void" +file = "Subjects\\CachedSubjectBase.cs" + +[[methods]] +parent = "CachedSubjectBase" +name = "Initialize" +sig = "void Initialize()" +returns = "void" +file = "Subjects\\CachedSubjectBase.cs" + +[[methods]] +parent = "CachedSubjectBase" +name = "RetrieveFromCache" +sig = "void RetrieveFromCache()" +returns = "void" +file = "Subjects\\CachedSubjectBase.cs" + +[[methods]] +parent = "CachedSubjectBase" +name = "DisposeCurrentData" +sig = "void DisposeCurrentData()" +returns = "void" +file = "Subjects\\CachedSubjectBase.cs" + +[[methods]] +parent = "CachedSubjectBase" +name = "ConvertModelToCachedData" +sig = "TCacheable ConvertModelToCachedData(T data)" +returns = "TCacheable" +file = "Subjects\\CachedSubjectBase.cs" + +[[methods]] +parent = "CachedSubjectBase" +name = "ConvertCachedDataToModel" +sig = "T ConvertCachedDataToModel(TCacheable cachedData)" +returns = "T" file = "Subjects\\CachedSubjectBase.cs" [[classes]] name = "CollectionCachedSubject" ns = "FEx.PersistentStorage.Rx.Subjects" -base = "CollectionCachedSubjectBase - where TCacheable : class, ICacheableItem" +base = "CollectionCachedSubjectBase" +file = "Subjects\\CollectionCachedSubject.cs" + +[[ctors]] +parent = "CollectionCachedSubject" +sig = "CollectionCachedSubject(ICacheService cacheService, ClearCacheReason clearCacheReason)" +file = "Subjects\\CollectionCachedSubject.cs" + +[[methods]] +parent = "CollectionCachedSubject" +name = "RetrieveFromCache" +sig = "void RetrieveFromCache()" +returns = "void" file = "Subjects\\CollectionCachedSubject.cs" [[classes]] name = "CollectionCachedSubjectBase" ns = "FEx.PersistentStorage.Rx.Subjects" -base = "CachedSubjectBase, T, TCacheable> - where TCacheable : class, ICacheableItem" +base = "CachedSubjectBase, T, TCacheable>" +file = "Subjects\\CollectionCachedSubjectBase.cs" + +[[ctors]] +parent = "CollectionCachedSubjectBase" +sig = "CollectionCachedSubjectBase(ICacheService cacheService, ClearCacheReason clearCacheReason)" +file = "Subjects\\CollectionCachedSubjectBase.cs" + +[[methods]] +parent = "CollectionCachedSubjectBase" +name = "OnNext" +sig = "void OnNext(IReadOnlyCollection value)" +returns = "void" +file = "Subjects\\CollectionCachedSubjectBase.cs" + +[[methods]] +parent = "CollectionCachedSubjectBase" +name = "DisposeCurrentData" +sig = "void DisposeCurrentData()" +returns = "void" file = "Subjects\\CollectionCachedSubjectBase.cs" [[classes]] name = "EnhancedCollectionCachedSubject" ns = "FEx.PersistentStorage.Rx.Subjects" -base = "CollectionCachedSubjectBase - where TCacheable : class, ICacheableItem" +base = "CollectionCachedSubjectBase" +file = "Subjects\\EnhancedCollectionCachedSubject.cs" + +[[ctors]] +parent = "EnhancedCollectionCachedSubject" +sig = "EnhancedCollectionCachedSubject(ICacheService cacheService, ClearCacheReason clearCacheReason)" +file = "Subjects\\EnhancedCollectionCachedSubject.cs" + +[[methods]] +parent = "EnhancedCollectionCachedSubject" +name = "GetEnhancement" +sig = "TEnhancement GetEnhancement(List cachedData)" +returns = "TEnhancement" +file = "Subjects\\EnhancedCollectionCachedSubject.cs" + +[[methods]] +parent = "EnhancedCollectionCachedSubject" +name = "ConvertCachedDataToModel" +sig = "T ConvertCachedDataToModel(TCacheable cachedData, TEnhancement enhancement)" +returns = "T" +file = "Subjects\\EnhancedCollectionCachedSubject.cs" + +[[methods]] +parent = "EnhancedCollectionCachedSubject" +name = "RetrieveFromCache" +sig = "void RetrieveFromCache()" +returns = "void" file = "Subjects\\EnhancedCollectionCachedSubject.cs" [[classes]] name = "SingleCachedSubject" ns = "FEx.PersistentStorage.Rx.Subjects" -base = "CachedSubjectBase - where TCacheable : class, ICacheableItem" +base = "CachedSubjectBase" +file = "Subjects\\SingleCachedSubject.cs" + +[[ctors]] +parent = "SingleCachedSubject" +sig = "SingleCachedSubject(ICacheService cacheService, ClearCacheReason clearCacheReason)" +file = "Subjects\\SingleCachedSubject.cs" + +[[ctors]] +parent = "SingleCachedSubject" +sig = "SingleCachedSubject(ICacheService cacheService, ClearCacheReason clearCacheReason, T defaultValue)" +file = "Subjects\\SingleCachedSubject.cs" + +[[methods]] +parent = "SingleCachedSubject" +name = "OnNext" +sig = "void OnNext(T value)" +returns = "void" +file = "Subjects\\SingleCachedSubject.cs" + +[[methods]] +parent = "SingleCachedSubject" +name = "RetrieveFromCache" +sig = "void RetrieveFromCache()" +returns = "void" +file = "Subjects\\SingleCachedSubject.cs" + +[[methods]] +parent = "SingleCachedSubject" +name = "DisposeCurrentData" +sig = "void DisposeCurrentData()" +returns = "void" file = "Subjects\\SingleCachedSubject.cs" diff --git a/.api-surface/FEx/PersistentStorage.toml b/.api-surface/FEx/PersistentStorage.toml index 508a1171..3430f7d9 100644 --- a/.api-surface/FEx/PersistentStorage.toml +++ b/.api-surface/FEx/PersistentStorage.toml @@ -8,50 +8,460 @@ ns = "FEx.PersistentStorage" base = "ICacheService" file = "CacheService.cs" +[[ctors]] +parent = "CacheService" +sig = "CacheService(ILocalStorageService localStorageService, IFExLogger logger)" +file = "CacheService.cs" + +[[methods]] +parent = "CacheService" +name = "Add" +sig = "BsonValue Add(T item) where T : ICacheableItem" +returns = "BsonValue" +file = "CacheService.cs" + +[[methods]] +parent = "CacheService" +name = "Add" +sig = "void Add(IEnumerable items) where T : ICacheableItem" +returns = "void" +file = "CacheService.cs" + +[[methods]] +parent = "CacheService" +name = "Update" +sig = "bool Update(T item) where T : ICacheableItem" +returns = "bool" +file = "CacheService.cs" + +[[methods]] +parent = "CacheService" +name = "Upsert" +sig = "bool Upsert(T item, Expression> predicate) where T : ICacheableItem" +returns = "bool" +file = "CacheService.cs" + +[[methods]] +parent = "CacheService" +name = "Upsert" +sig = "void Upsert(IEnumerable items, Expression> predicate) where T : ICacheableItem" +returns = "void" +file = "CacheService.cs" + +[[methods]] +parent = "CacheService" +name = "Delete" +sig = "bool Delete(ObjectId id) where T : ICacheableItem" +returns = "bool" +file = "CacheService.cs" + +[[methods]] +parent = "CacheService" +name = "Delete" +sig = "bool Delete(IEnumerable items) where T : ICacheableItem" +returns = "bool" +file = "CacheService.cs" + +[[methods]] +parent = "CacheService" +name = "Delete" +sig = "bool Delete(Expression> predicate) where T : ICacheableItem" +returns = "bool" +file = "CacheService.cs" + +[[methods]] +parent = "CacheService" +name = "FirstOrDefault" +sig = "T FirstOrDefault(Expression> predicate) where T : ICacheableItem" +returns = "T" +file = "CacheService.cs" + +[[methods]] +parent = "CacheService" +name = "Get" +sig = "IReadOnlyCollection Get(Expression> predicate) where T : ICacheableItem" +returns = "IReadOnlyCollection" +file = "CacheService.cs" + +[[methods]] +parent = "CacheService" +name = "ReplaceWith" +sig = "void ReplaceWith(IEnumerable items) where T : ICacheableItem" +returns = "void" +file = "CacheService.cs" + +[[methods]] +parent = "CacheService" +name = "ReplaceWith" +sig = "BsonValue ReplaceWith(T item) where T : ICacheableItem" +returns = "BsonValue" +file = "CacheService.cs" + +[[methods]] +parent = "CacheService" +name = "ClearCache" +sig = "void ClearCache(ClearCacheReason clearCacheReason)" +returns = "void" +file = "CacheService.cs" + +[[methods]] +parent = "CacheService" +name = "CacheFile" +sig = "IFExCachedFile CacheFile(IFExDownloadResult downloadResult)" +returns = "IFExCachedFile" +file = "CacheService.cs" + +[[methods]] +parent = "CacheService" +name = "GetCachedFile" +sig = "IFExCachedFile GetCachedFile(Uri fileUrl)" +returns = "IFExCachedFile" +file = "CacheService.cs" + +[[methods]] +parent = "CacheService" +name = "UpdateFile" +sig = "void UpdateFile(IFExCachedFile cachedFile)" +returns = "void" +file = "CacheService.cs" + +[[methods]] +parent = "CacheService" +name = "DeleteExpiredFiles" +sig = "void DeleteExpiredFiles()" +returns = "void" +file = "CacheService.cs" + [[classes]] name = "DatabaseProvider" ns = "FEx.PersistentStorage" base = "IDatabaseProvider, IDisposable" file = "DatabaseProvider.cs" +[[properties]] +parent = "DatabaseProvider" +name = "Repository" +sig = "ILiteRepository Repository { get; }" +returns = "ILiteRepository" +file = "DatabaseProvider.cs" + +[[properties]] +parent = "DatabaseProvider" +name = "DbLock" +sig = "ExtendedReaderWriterLockSlim DbLock { get; }" +returns = "ExtendedReaderWriterLockSlim" +file = "DatabaseProvider.cs" + +[[ctors]] +parent = "DatabaseProvider" +sig = "DatabaseProvider(IDatabaseFilePathResolver filePathResolver)" +file = "DatabaseProvider.cs" + +[[methods]] +parent = "DatabaseProvider" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "DatabaseProvider.cs" + [[classes]] name = "DefaultDatabaseFilePathResolver" ns = "FEx.PersistentStorage" base = "IDatabaseFilePathResolver" file = "DefaultDatabaseFilePathResolver.cs" +[[ctors]] +parent = "DefaultDatabaseFilePathResolver" +sig = "DefaultDatabaseFilePathResolver(string appName)" +file = "DefaultDatabaseFilePathResolver.cs" + +[[methods]] +parent = "DefaultDatabaseFilePathResolver" +name = "GetDatabasesFolderPath" +sig = "string GetDatabasesFolderPath()" +returns = "string" +file = "DefaultDatabaseFilePathResolver.cs" + [[classes]] name = "FExPersistentStorageModule" ns = "FEx.PersistentStorage" base = "InitializeModule" file = "FExPersistentStorageModule.cs" +[[methods]] +parent = "FExPersistentStorageModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExPersistentStorageContainer container, IServiceCollection services)" +returns = "void" +file = "FExPersistentStorageModule.cs" + [[classes]] name = "FileLocalStorageService" ns = "FEx.PersistentStorage" base = "IFileLocalStorageService" file = "FileLocalStorageService.cs" +[[methods]] +parent = "FileLocalStorageService" +name = "CacheFile" +sig = "IFExCachedFile CacheFile(IFExDownloadResult downloadResult)" +returns = "IFExCachedFile" +file = "FileLocalStorageService.cs" + +[[methods]] +parent = "FileLocalStorageService" +name = "GetCachedFile" +sig = "IFExCachedFile GetCachedFile(Uri fileUrl)" +returns = "IFExCachedFile" +file = "FileLocalStorageService.cs" + +[[methods]] +parent = "FileLocalStorageService" +name = "UpdateFile" +sig = "void UpdateFile(IFExCachedFile cachedFile)" +returns = "void" +file = "FileLocalStorageService.cs" + +[[methods]] +parent = "FileLocalStorageService" +name = "DeleteExpiredFiles" +sig = "void DeleteExpiredFiles()" +returns = "void" +file = "FileLocalStorageService.cs" + +[[methods]] +parent = "FileLocalStorageService" +name = "GetFileId" +sig = "static string GetFileId(Uri fileUrl)" +returns = "string" +file = "FileLocalStorageService.cs" +static = true + [[classes]] name = "LiteDbFileLocalStorageService" ns = "FEx.PersistentStorage" base = "FileLocalStorageService" file = "LiteDbFileLocalStorageService.cs" +[[ctors]] +parent = "LiteDbFileLocalStorageService" +sig = "LiteDbFileLocalStorageService(IDatabaseProvider databaseProvider)" +file = "LiteDbFileLocalStorageService.cs" + +[[methods]] +parent = "LiteDbFileLocalStorageService" +name = "CacheFile" +sig = "IFExCachedFile CacheFile(IFExDownloadResult downloadResult)" +returns = "IFExCachedFile" +file = "LiteDbFileLocalStorageService.cs" + +[[methods]] +parent = "LiteDbFileLocalStorageService" +name = "GetCachedFile" +sig = "IFExCachedFile GetCachedFile(Uri fileUrl)" +returns = "IFExCachedFile" +file = "LiteDbFileLocalStorageService.cs" + +[[methods]] +parent = "LiteDbFileLocalStorageService" +name = "UpdateFile" +sig = "void UpdateFile(IFExCachedFile cachedFile)" +returns = "void" +file = "LiteDbFileLocalStorageService.cs" + +[[methods]] +parent = "LiteDbFileLocalStorageService" +name = "DeleteExpiredFiles" +sig = "void DeleteExpiredFiles()" +returns = "void" +file = "LiteDbFileLocalStorageService.cs" + [[classes]] name = "LocalStorageService" ns = "FEx.PersistentStorage" base = "ILocalStorageService" file = "LocalStorageService.cs" +[[properties]] +parent = "LocalStorageService" +name = "Context" +sig = "ILiteRepository Context { get; }" +returns = "ILiteRepository" +file = "LocalStorageService.cs" + +[[properties]] +parent = "LocalStorageService" +name = "DbLock" +sig = "ExtendedReaderWriterLockSlim DbLock { get; }" +returns = "ExtendedReaderWriterLockSlim" +file = "LocalStorageService.cs" + +[[ctors]] +parent = "LocalStorageService" +sig = "LocalStorageService(IDatabaseProvider databaseProvider, IFileLocalStorageService fileLocalStorageService, IFExLogger logger)" +file = "LocalStorageService.cs" + +[[methods]] +parent = "LocalStorageService" +name = "CacheFile" +sig = "IFExCachedFile CacheFile(IFExDownloadResult downloadResult)" +returns = "IFExCachedFile" +file = "LocalStorageService.cs" + +[[methods]] +parent = "LocalStorageService" +name = "GetCachedFile" +sig = "IFExCachedFile GetCachedFile(Uri fileUrl)" +returns = "IFExCachedFile" +file = "LocalStorageService.cs" + +[[methods]] +parent = "LocalStorageService" +name = "UpdateFile" +sig = "void UpdateFile(IFExCachedFile cachedFile)" +returns = "void" +file = "LocalStorageService.cs" + +[[methods]] +parent = "LocalStorageService" +name = "DeleteExpiredFiles" +sig = "void DeleteExpiredFiles()" +returns = "void" +file = "LocalStorageService.cs" + +[[methods]] +parent = "LocalStorageService" +name = "GetAll" +sig = "IReadOnlyList GetAll(Expression> predicate) where T : ICacheableItem" +returns = "IReadOnlyList" +file = "LocalStorageService.cs" + +[[methods]] +parent = "LocalStorageService" +name = "FirstOrDefault" +sig = "T FirstOrDefault(Expression> predicate) where T : ICacheableItem" +returns = "T" +file = "LocalStorageService.cs" + +[[methods]] +parent = "LocalStorageService" +name = "Insert" +sig = "BsonValue Insert(T item) where T : ICacheableItem" +returns = "BsonValue" +file = "LocalStorageService.cs" + +[[methods]] +parent = "LocalStorageService" +name = "Insert" +sig = "void Insert(IEnumerable items) where T : ICacheableItem" +returns = "void" +file = "LocalStorageService.cs" + +[[methods]] +parent = "LocalStorageService" +name = "Update" +sig = "bool Update(T item) where T : ICacheableItem" +returns = "bool" +file = "LocalStorageService.cs" + +[[methods]] +parent = "LocalStorageService" +name = "Upsert" +sig = "bool Upsert(T item, Expression> predicate) where T : ICacheableItem" +returns = "bool" +file = "LocalStorageService.cs" + +[[methods]] +parent = "LocalStorageService" +name = "Upsert" +sig = "void Upsert(IEnumerable items, Expression> predicate) where T : ICacheableItem" +returns = "void" +file = "LocalStorageService.cs" + +[[methods]] +parent = "LocalStorageService" +name = "Delete" +sig = "bool Delete(ObjectId id) where T : ICacheableItem" +returns = "bool" +file = "LocalStorageService.cs" + +[[methods]] +parent = "LocalStorageService" +name = "Delete" +sig = "bool Delete(IEnumerable items) where T : ICacheableItem" +returns = "bool" +file = "LocalStorageService.cs" + +[[methods]] +parent = "LocalStorageService" +name = "DeleteAll" +sig = "bool DeleteAll(Expression> predicate) where T : ICacheableItem" +returns = "bool" +file = "LocalStorageService.cs" + +[[methods]] +parent = "LocalStorageService" +name = "ReplaceWith" +sig = "void ReplaceWith(IEnumerable items) where T : ICacheableItem" +returns = "void" +file = "LocalStorageService.cs" + +[[methods]] +parent = "LocalStorageService" +name = "ReplaceWith" +sig = "BsonValue ReplaceWith(T item) where T : ICacheableItem" +returns = "BsonValue" +file = "LocalStorageService.cs" + [[classes]] name = "PlainFileLocalStorageService" ns = "FEx.PersistentStorage" base = "FileLocalStorageService" file = "PlainFileLocalStorageService.cs" +[[ctors]] +parent = "PlainFileLocalStorageService" +sig = "PlainFileLocalStorageService(IDatabaseFilePathResolver databaseFilePathResolver)" +file = "PlainFileLocalStorageService.cs" + +[[methods]] +parent = "PlainFileLocalStorageService" +name = "CacheFile" +sig = "IFExCachedFile CacheFile(IFExDownloadResult downloadResult)" +returns = "IFExCachedFile" +file = "PlainFileLocalStorageService.cs" + +[[methods]] +parent = "PlainFileLocalStorageService" +name = "GetCachedFile" +sig = "IFExCachedFile GetCachedFile(Uri fileUrl)" +returns = "IFExCachedFile" +file = "PlainFileLocalStorageService.cs" + +[[methods]] +parent = "PlainFileLocalStorageService" +name = "UpdateFile" +sig = "void UpdateFile(IFExCachedFile cachedFile)" +returns = "void" +file = "PlainFileLocalStorageService.cs" + +[[methods]] +parent = "PlainFileLocalStorageService" +name = "DeleteExpiredFiles" +sig = "void DeleteExpiredFiles()" +returns = "void" +file = "PlainFileLocalStorageService.cs" + [[classes]] name = "LiteRepositoryExtensions" ns = "FEx.PersistentStorage.Extensions" file = "Extensions\\LiteRepositoryExtensions.cs" +[[methods]] +parent = "LiteRepositoryExtensions" +name = "GetRepository" +sig = "static LiteRepository GetRepository(string dbFilePath)" +returns = "LiteRepository" +file = "Extensions\\LiteRepositoryExtensions.cs" +static = true + diff --git a/.api-surface/FEx/Platforms.Windows.toml b/.api-surface/FEx/Platforms.Windows.toml index 355247f5..80a1a3da 100644 --- a/.api-surface/FEx/Platforms.Windows.toml +++ b/.api-surface/FEx/Platforms.Windows.toml @@ -10,8 +10,8 @@ static = true [[extensions]] name = "SetEverybodyFullControl" -sig = "bool SetEverybodyFullControl(this DirectoryInfo dInfo, params string[] excludes)" returns = "bool" +sig = "bool SetEverybodyFullControl(this DirectoryInfo dInfo, params string[] excludes)" file = "Extensions\\FileSystemExtensions.cs" [[classes]] @@ -23,22 +23,22 @@ static = true [[extensions]] name = "SamAccountName" -sig = "string SamAccountName(this IIdentity user)" returns = "string" +sig = "string SamAccountName(this IIdentity user)" summary = "Extracts the SAMAccountName part of the full identity name" file = "Extensions\\IdentityExtensions.cs" [[extensions]] name = "Domain" -sig = "string Domain(this IIdentity user)" returns = "string" +sig = "string Domain(this IIdentity user)" summary = "Extracts the domain name part of the full identity name" file = "Extensions\\IdentityExtensions.cs" [[extensions]] name = "LogFormattedName" -sig = "string LogFormattedName(this IIdentity user)" returns = "string" +sig = "string LogFormattedName(this IIdentity user)" summary = "Extracts the SAMAccountName part of the full identity name and formats it the way the activity log wants it." file = "Extensions\\IdentityExtensions.cs" @@ -47,9 +47,87 @@ name = "ACL" ns = "FEx.Platforms.Windows.Models" file = "Models\\ACL.cs" +[[properties]] +parent = "ACL" +name = "Path" +sig = "string Path { get; }" +returns = "string" +file = "Models\\ACL.cs" + +[[properties]] +parent = "ACL" +name = "HasEveryoneAccess" +sig = "bool HasEveryoneAccess { get; }" +returns = "bool" +file = "Models\\ACL.cs" + +[[properties]] +parent = "ACL" +name = "HasEveryoneOwner" +sig = "bool HasEveryoneOwner { get; }" +returns = "bool" +file = "Models\\ACL.cs" + +[[ctors]] +parent = "ACL" +sig = "ACL(IReadOnlyList splitted)" +file = "Models\\ACL.cs" + +[[ctors]] +parent = "ACL" +sig = "ACL(string v1, bool v2, bool v3)" +file = "Models\\ACL.cs" + +[[methods]] +parent = "ACL" +name = "ToString" +sig = "string ToString()" +returns = "string" +file = "Models\\ACL.cs" + [[classes]] name = "ElevatedCmd" ns = "FEx.Platforms.Windows.Utilities" base = "Cmd" file = "Utilities\\ElevatedCmd.cs" +[[properties]] +parent = "ElevatedCmd" +name = "OutFile" +sig = "string OutFile { get; set; }" +returns = "string" +file = "Utilities\\ElevatedCmd.cs" + +[[properties]] +parent = "ElevatedCmd" +name = "OutTask" +sig = "Task OutTask { get; set; }" +returns = "Task" +file = "Utilities\\ElevatedCmd.cs" + +[[ctors]] +parent = "ElevatedCmd" +sig = "ElevatedCmd(string procName = \"cmd\")" +file = "Utilities\\ElevatedCmd.cs" + +[[methods]] +parent = "ElevatedCmd" +name = "StartProc" +sig = "void StartProc()" +returns = "void" +file = "Utilities\\ElevatedCmd.cs" + +[[methods]] +parent = "ElevatedCmd" +name = "OnStarted" +sig = "void OnStarted(bool waitForExit, Action onStarted)" +returns = "void" +file = "Utilities\\ElevatedCmd.cs" + +[[methods]] +parent = "ElevatedCmd" +name = "AttachToOutput" +sig = "void AttachToOutput()" +returns = "void" +file = "Utilities\\ElevatedCmd.cs" + diff --git a/.api-surface/FEx/Platforms.toml b/.api-surface/FEx/Platforms.toml index b7286e9c..8ca949c4 100644 --- a/.api-surface/FEx/Platforms.toml +++ b/.api-surface/FEx/Platforms.toml @@ -8,27 +8,157 @@ ns = "FEx.Platforms" base = "FExInitializable" file = "FExPlatforms.cs" +[[properties]] +parent = "FExPlatforms" +name = "RegistryService" +sig = "static IRegistryService RegistryService { get; }" +returns = "IRegistryService" +file = "FExPlatforms.cs" +static = true + +[[ctors]] +parent = "FExPlatforms" +sig = "FExPlatforms(IRegistryService registryService)" +file = "FExPlatforms.cs" + +[[methods]] +parent = "FExPlatforms" +name = "OnInitialize" +sig = "void OnInitialize()" +returns = "void" +file = "FExPlatforms.cs" + [[classes]] name = "FExPlatformsModule" ns = "FEx.Platforms" base = "InitializeModule" file = "FExPlatformsModule.cs" +[[methods]] +parent = "FExPlatformsModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExPlatformsContainer container, IServiceCollection services)" +returns = "void" +file = "FExPlatformsModule.cs" + [[classes]] name = "RegistryService" ns = "FEx.Platforms" base = "IRegistryService" file = "RegistryService.cs" -[[interfaces]] -name = "IFExPlatformsContainer" -ns = "FEx.Platforms.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IFExPlatformsContainer.cs" +[[properties]] +parent = "RegistryService" +name = "Instance" +sig = "static RegistryService Instance { get; }" +returns = "RegistryService" +file = "RegistryService.cs" +static = true -[[interfaces]] -name = "IRegistryService" -ns = "FEx.Platforms.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IRegistryService.cs" +[[methods]] +parent = "RegistryService" +name = "GetInstalledApplications" +sig = "List GetInstalledApplications()" +returns = "List" +file = "RegistryService.cs" + +[[methods]] +parent = "RegistryService" +name = "GetVersionFromRegistry" +sig = "List GetVersionFromRegistry()" +returns = "List" +file = "RegistryService.cs" + +[[methods]] +parent = "RegistryService" +name = "Get45PlusFromRegistry" +sig = "List Get45PlusFromRegistry()" +returns = "List" +file = "RegistryService.cs" + +[[methods]] +parent = "RegistryService" +name = "GetClassesRootSubKey" +sig = "RegistryKey GetClassesRootSubKey(string subKey, bool writable)" +returns = "RegistryKey" +file = "RegistryService.cs" + +[[methods]] +parent = "RegistryService" +name = "GetLocalMachineSubKey" +sig = "RegistryKey GetLocalMachineSubKey(string subKey, bool writable)" +returns = "RegistryKey" +file = "RegistryService.cs" + +[[methods]] +parent = "RegistryService" +name = "GetCurrentUserSubKey" +sig = "RegistryKey GetCurrentUserSubKey(string subKey, bool writable)" +returns = "RegistryKey" +file = "RegistryService.cs" + +[[methods]] +parent = "RegistryService" +name = "GetSubKey" +sig = "RegistryKey GetSubKey(RegistryKey registry, string subKey, bool writable)" +returns = "RegistryKey" +file = "RegistryService.cs" + +[[methods]] +parent = "RegistryService" +name = "GetOrAddCurrentUserSubKey" +sig = "RegistryKey GetOrAddCurrentUserSubKey(string subKey, bool writable)" +returns = "RegistryKey" +file = "RegistryService.cs" + +[[methods]] +parent = "RegistryService" +name = "GetOrAddLocalMachineSubKey" +sig = "RegistryKey GetOrAddLocalMachineSubKey(string subKey, bool writable)" +returns = "RegistryKey" +file = "RegistryService.cs" + +[[methods]] +parent = "RegistryService" +name = "SetStartup" +sig = "void SetStartup(string appName, string executablePath, bool enable, bool global)" +returns = "void" +file = "RegistryService.cs" + +[[methods]] +parent = "RegistryService" +name = "GetStandardBrowserPath" +sig = "string GetStandardBrowserPath()" +returns = "string" +file = "RegistryService.cs" + +[[methods]] +parent = "RegistryService" +name = "GetDefaultExtension" +sig = "string GetDefaultExtension(string mimeType)" +returns = "string" +file = "RegistryService.cs" + +[[methods]] +parent = "RegistryService" +name = "GetDefaultMimeType" +sig = "string GetDefaultMimeType(string extension)" +returns = "string" +file = "RegistryService.cs" + +[[methods]] +parent = "RegistryService" +name = "GetDefaultExtension" +sig = "string GetDefaultExtension(MediaTypes mediaType)" +returns = "string" +file = "RegistryService.cs" + +[[methods]] +parent = "RegistryService" +name = "GetOrAddRegistryKeyStringValue" +sig = "string GetOrAddRegistryKeyStringValue(string path, string keyName, Func getNewValue)" +returns = "string" +file = "RegistryService.cs" [[classes]] name = "RegistryKeyExtensions" @@ -36,6 +166,18 @@ ns = "FEx.Platforms.Extensions" file = "Extensions\\RegistryKeyExtensions.cs" static = true +[[extensions]] +name = "GetKeyValue" +returns = "T" +sig = "T GetKeyValue(this RegistryKey reg, string keyName, T fallback)" +file = "Extensions\\RegistryKeyExtensions.cs" + +[[extensions]] +name = "GetKeyValue" +returns = "T" +sig = "T GetKeyValue(this RegistryKey reg, string keyName)" +file = "Extensions\\RegistryKeyExtensions.cs" + [[classes]] name = "RegistryServiceExtensions" ns = "FEx.Platforms.Extensions" @@ -44,43 +186,159 @@ static = true [[extensions]] name = "GetClassesRootSubKey" -sig = "RegistryKey GetClassesRootSubKey(this IRegistryService service, string subKey)" returns = "RegistryKey" +sig = "RegistryKey GetClassesRootSubKey(this IRegistryService service, string subKey)" file = "Extensions\\RegistryServiceExtensions.cs" [[extensions]] name = "GetLocalMachineSubKey" -sig = "RegistryKey GetLocalMachineSubKey(this IRegistryService service, string subKey)" returns = "RegistryKey" +sig = "RegistryKey GetLocalMachineSubKey(this IRegistryService service, string subKey)" file = "Extensions\\RegistryServiceExtensions.cs" [[extensions]] name = "GetCurrentUserSubKey" -sig = "RegistryKey GetCurrentUserSubKey(this IRegistryService service, string subKey)" returns = "RegistryKey" +sig = "RegistryKey GetCurrentUserSubKey(this IRegistryService service, string subKey)" file = "Extensions\\RegistryServiceExtensions.cs" [[extensions]] name = "GetSubKey" -sig = "RegistryKey GetSubKey(this IRegistryService service, RegistryKey registry, string subKey)" returns = "RegistryKey" +sig = "RegistryKey GetSubKey(this IRegistryService service, RegistryKey registry, string subKey)" file = "Extensions\\RegistryServiceExtensions.cs" [[extensions]] name = "GetOrAddCurrentUserSubKey" -sig = "RegistryKey GetOrAddCurrentUserSubKey(this IRegistryService service, string subKey)" returns = "RegistryKey" +sig = "RegistryKey GetOrAddCurrentUserSubKey(this IRegistryService service, string subKey)" file = "Extensions\\RegistryServiceExtensions.cs" [[extensions]] name = "GetOrAddLocalMachineSubKey" -sig = "RegistryKey GetOrAddLocalMachineSubKey(this IRegistryService service, string subKey)" returns = "RegistryKey" +sig = "RegistryKey GetOrAddLocalMachineSubKey(this IRegistryService service, string subKey)" file = "Extensions\\RegistryServiceExtensions.cs" [[extensions]] name = "SetStartup" -sig = "void SetStartup(this IRegistryService service, string appName, string executablePath, bool enable)" returns = "void" +sig = "void SetStartup(this IRegistryService service, string appName, string executablePath, bool enable)" file = "Extensions\\RegistryServiceExtensions.cs" +[[interfaces]] +name = "IFExPlatformsContainer" +ns = "FEx.Platforms.Abstractions.Interfaces" +base = "IContainer, IContainer" +file = "Abstractions\\Interfaces\\IFExPlatformsContainer.cs" + +[[interfaces]] +name = "IRegistryService" +ns = "FEx.Platforms.Abstractions.Interfaces" +file = "Abstractions\\Interfaces\\IRegistryService.cs" + +[[methods]] +parent = "IRegistryService" +name = "GetInstalledApplications" +sig = "List GetInstalledApplications()" +returns = "List" +file = "Abstractions\\Interfaces\\IRegistryService.cs" + +[[methods]] +parent = "IRegistryService" +name = "GetVersionFromRegistry" +sig = "List GetVersionFromRegistry()" +returns = "List" +file = "Abstractions\\Interfaces\\IRegistryService.cs" + +[[methods]] +parent = "IRegistryService" +name = "Get45PlusFromRegistry" +sig = "List Get45PlusFromRegistry()" +returns = "List" +file = "Abstractions\\Interfaces\\IRegistryService.cs" + +[[methods]] +parent = "IRegistryService" +name = "GetClassesRootSubKey" +sig = "RegistryKey GetClassesRootSubKey(string subKey, bool writable)" +returns = "RegistryKey" +file = "Abstractions\\Interfaces\\IRegistryService.cs" + +[[methods]] +parent = "IRegistryService" +name = "GetLocalMachineSubKey" +sig = "RegistryKey GetLocalMachineSubKey(string subKey, bool writable)" +returns = "RegistryKey" +file = "Abstractions\\Interfaces\\IRegistryService.cs" + +[[methods]] +parent = "IRegistryService" +name = "GetCurrentUserSubKey" +sig = "RegistryKey GetCurrentUserSubKey(string subKey, bool writable)" +returns = "RegistryKey" +file = "Abstractions\\Interfaces\\IRegistryService.cs" + +[[methods]] +parent = "IRegistryService" +name = "GetSubKey" +sig = "RegistryKey GetSubKey(RegistryKey registry, string subKey, bool writable)" +returns = "RegistryKey" +file = "Abstractions\\Interfaces\\IRegistryService.cs" + +[[methods]] +parent = "IRegistryService" +name = "GetOrAddCurrentUserSubKey" +sig = "RegistryKey GetOrAddCurrentUserSubKey(string subKey, bool writable)" +returns = "RegistryKey" +file = "Abstractions\\Interfaces\\IRegistryService.cs" + +[[methods]] +parent = "IRegistryService" +name = "GetOrAddLocalMachineSubKey" +sig = "RegistryKey GetOrAddLocalMachineSubKey(string subKey, bool writable)" +returns = "RegistryKey" +file = "Abstractions\\Interfaces\\IRegistryService.cs" + +[[methods]] +parent = "IRegistryService" +name = "SetStartup" +sig = "void SetStartup(string appName, string executablePath, bool enable, bool global)" +returns = "void" +file = "Abstractions\\Interfaces\\IRegistryService.cs" + +[[methods]] +parent = "IRegistryService" +name = "GetStandardBrowserPath" +sig = "string GetStandardBrowserPath()" +returns = "string" +file = "Abstractions\\Interfaces\\IRegistryService.cs" + +[[methods]] +parent = "IRegistryService" +name = "GetDefaultExtension" +sig = "string GetDefaultExtension(string mimeType)" +returns = "string" +file = "Abstractions\\Interfaces\\IRegistryService.cs" + +[[methods]] +parent = "IRegistryService" +name = "GetDefaultExtension" +sig = "string GetDefaultExtension(MediaTypes mediaType)" +returns = "string" +file = "Abstractions\\Interfaces\\IRegistryService.cs" + +[[methods]] +parent = "IRegistryService" +name = "GetDefaultMimeType" +sig = "string GetDefaultMimeType(string extension)" +returns = "string" +file = "Abstractions\\Interfaces\\IRegistryService.cs" + +[[methods]] +parent = "IRegistryService" +name = "GetOrAddRegistryKeyStringValue" +sig = "string GetOrAddRegistryKeyStringValue(string path, string keyName, Func getNewValue)" +returns = "string" +file = "Abstractions\\Interfaces\\IRegistryService.cs" + diff --git a/.api-surface/FEx/RESXx.toml b/.api-surface/FEx/RESXx.toml index d6b11ece..cc8e37ff 100644 --- a/.api-surface/FEx/RESXx.toml +++ b/.api-surface/FEx/RESXx.toml @@ -8,3 +8,25 @@ ns = "FEx.RESXx" base = "IResxManager" file = "ResxManager.cs" +[[methods]] +parent = "ResxManager" +name = "UpdateResourceFile" +sig = "void UpdateResourceFile(List> data, string path)" +returns = "void" +file = "ResxManager.cs" + +[[methods]] +parent = "ResxManager" +name = "GetResourcesEntries" +sig = "Dictionary GetResourcesEntries(string path)" +returns = "Dictionary" +file = "ResxManager.cs" + +[[methods]] +parent = "ResxManager" +name = "Resgen" +sig = "string[] Resgen(string resx, string resxDesigner, string fileName, string projectNamespace)" +returns = "string[]" +summary = "Resgens the specified file." +file = "ResxManager.cs" + diff --git a/.api-surface/FEx/SecureStorage.Abstractions.toml b/.api-surface/FEx/SecureStorage.Abstractions.toml index e0e63fce..d6dec084 100644 --- a/.api-surface/FEx/SecureStorage.Abstractions.toml +++ b/.api-surface/FEx/SecureStorage.Abstractions.toml @@ -7,3 +7,17 @@ name = "ISecureStorageService" ns = "FEx.SecureStorage.Abstractions" file = "ISecureStorageService.cs" +[[methods]] +parent = "ISecureStorageService" +name = "Get" +sig = "T Get(string key)" +returns = "T" +file = "ISecureStorageService.cs" + +[[methods]] +parent = "ISecureStorageService" +name = "Set" +sig = "void Set(string key, object content)" +returns = "void" +file = "ISecureStorageService.cs" + diff --git a/.api-surface/FEx/SecureStorage.toml b/.api-surface/FEx/SecureStorage.toml index 1904e4e0..86df1b83 100644 --- a/.api-surface/FEx/SecureStorage.toml +++ b/.api-surface/FEx/SecureStorage.toml @@ -6,38 +6,58 @@ path = "src\\FEx.SecureStorage" name = "FileSecureStorageService" ns = "FEx.SecureStorage" base = "ISecureStorageService" -summary = "Cross-platform fallback storage that persists values as encrypted files under ~/.fexStorage/. Uses a per-user/per-machine cipher derived from {UserName}@{MachineName}. Not OS-level secure - prefer WindowsDpapiSecureStorageService, MacOsKeychainSecureStorageService or LinuxLibsecretSecureStorageService when available." +summary = "Cross-platform fallback storage that persists values as encrypted files under ~/.fexStorage/ . Uses a per-user/per-machine cipher derived from {UserName}@{MachineName} . Not OS-level secure - prefer WindowsDpapiSecureStorageService , MacOsKeychainSecureStorageService or LinuxLibsecretSecureStorageService when available." +file = "FileSecureStorageService.cs" + +[[ctors]] +parent = "FileSecureStorageService" +sig = "FileSecureStorageService()" +file = "FileSecureStorageService.cs" + +[[ctors]] +parent = "FileSecureStorageService" +sig = "FileSecureStorageService(string cipher, DirectoryInfo storage)" +file = "FileSecureStorageService.cs" + +[[methods]] +parent = "FileSecureStorageService" +name = "Get" +sig = "T Get(string key)" +returns = "T" +file = "FileSecureStorageService.cs" + +[[methods]] +parent = "FileSecureStorageService" +name = "Set" +sig = "void Set(string key, object content)" +returns = "void" file = "FileSecureStorageService.cs" [[interfaces]] name = "ISecureStorageContainer" ns = "FEx.SecureStorage" +base = "IContainer" file = "ISecureStorageContainer.cs" -[[classes]] -name = "LinuxLibsecretSecureStorageService" -ns = "FEx.SecureStorage" -base = "ISecureStorageService" -summary = "Linux-only secure storage backed by libsecret (the freedesktop Secret Service API, used by GNOME Keyring and KWallet via secret-service). Items are tagged with the configured service name (default com.flakroup.fex.securestorage) and the supplied key as the key attribute. Requires libsecret-1.so.0 to be installed on the target machine - the constructor throws if the library cannot be loaded." -file = "LinuxLibsecretSecureStorageService.cs" - -[[classes]] -name = "MacOsKeychainSecureStorageService" -ns = "FEx.SecureStorage" -base = "ISecureStorageService" -summary = "macOS-only secure storage backed by the Security framework Keychain Services (generic password items). Items are tagged with the configured service name (default com.flakroup.fex.securestorage) and the supplied key as the account name. Values are JSON-serialized before being stored as UTF-8 bytes." -file = "MacOsKeychainSecureStorageService.cs" - [[classes]] name = "SecureStorageModule" ns = "FEx.SecureStorage" base = "InitializeModule" file = "SecureStorageModule.cs" -[[classes]] -name = "WindowsDpapiSecureStorageService" -ns = "FEx.SecureStorage" -base = "ISecureStorageService" -summary = "Windows-only secure storage backed by DPAPI (Data Protection API). Encryption is per-user (DataProtectionScope.CurrentUser), so payloads can only be decrypted by the same Windows user account that wrote them. Files are stored under ~/.fexStorage-dpapi/ with extension .dpapi." -file = "WindowsDpapiSecureStorageService.cs" +[[methods]] +parent = "SecureStorageModule" +name = "CreateSecureStorageService" +sig = "static ISecureStorageService CreateSecureStorageService()" +returns = "ISecureStorageService" +summary = "Picks the most secure available on the current OS. Order: Windows DPAPI > macOS Keychain > Linux libsecret > cross-platform file fallback. If libsecret is missing on Linux the factory silently falls back to the file implementation." +file = "SecureStorageModule.cs" +static = true + +[[methods]] +parent = "SecureStorageModule" +name = "RegisterServices" +sig = "void RegisterServices(ISecureStorageContainer container, IServiceCollection services)" +returns = "void" +file = "SecureStorageModule.cs" diff --git a/.api-surface/FEx/Sqlx.Abstractions.toml b/.api-surface/FEx/Sqlx.Abstractions.toml index 3285a6dc..f42aa66f 100644 --- a/.api-surface/FEx/Sqlx.Abstractions.toml +++ b/.api-surface/FEx/Sqlx.Abstractions.toml @@ -5,5 +5,13 @@ path = "src\\Sqlx.Abstractions" [[interfaces]] name = "ISqlDbHelper" ns = "FEx.Sqlx.Abstractions" +base = "IAsyncInitializable" +file = "ISqlDbHelper.cs" + +[[properties]] +parent = "ISqlDbHelper" +name = "SQLInstance" +sig = "string SQLInstance { get; }" +returns = "string" file = "ISqlDbHelper.cs" diff --git a/.api-surface/FEx/Sqlx.toml b/.api-surface/FEx/Sqlx.toml index 79a67051..4d373fe4 100644 --- a/.api-surface/FEx/Sqlx.toml +++ b/.api-surface/FEx/Sqlx.toml @@ -8,11 +8,414 @@ ns = "FEx.Sqlx" base = "AsyncInitializable, ISqlDbHelper" file = "SqlDbHelper.cs" +[[properties]] +parent = "SqlDbHelper" +name = "SQLInstanceInfo" +sig = "SQLInstanceInfo SQLInstanceInfo { get; }" +returns = "SQLInstanceInfo" +file = "SqlDbHelper.cs" + +[[properties]] +parent = "SqlDbHelper" +name = "SQLInstance" +sig = "string SQLInstance { get; }" +returns = "string" +file = "SqlDbHelper.cs" + +[[ctors]] +parent = "SqlDbHelper" +sig = "SqlDbHelper()" +file = "SqlDbHelper.cs" + +[[methods]] +parent = "SqlDbHelper" +name = "GetSqlInstancesAsync" +sig = "static Task> GetSqlInstancesAsync()" +returns = "Task>" +file = "SqlDbHelper.cs" +static = true + +[[methods]] +parent = "SqlDbHelper" +name = "OnInitializeAsync" +sig = "Task OnInitializeAsync()" +returns = "Task" +file = "SqlDbHelper.cs" + [[classes]] name = "SQLInstanceInfo" ns = "FEx.Sqlx" file = "SQLInstanceInfo.cs" +[[properties]] +parent = "SQLInstanceInfo" +name = "SQLInstance" +sig = "string SQLInstance { get; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "BuildClrVersion" +sig = "Version BuildClrVersion { get; set; }" +returns = "Version" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "Collation" +sig = "string Collation { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "CollationID" +sig = "int? CollationID { get; set; }" +returns = "int?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "ComparisonStyle" +sig = "int? ComparisonStyle { get; set; }" +returns = "int?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "ComputerNamePhysicalNetBIOS" +sig = "string ComputerNamePhysicalNetBIOS { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "Edition" +sig = "string Edition { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "EditionID" +sig = "string EditionID { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "EngineEdition" +sig = "string EngineEdition { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "FilestreamConfiguredLevel" +sig = "FileStreamEffectiveLevel? FilestreamConfiguredLevel { get; set; }" +returns = "FileStreamEffectiveLevel?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "FilestreamEffectiveLevel" +sig = "FileStreamEffectiveLevel? FilestreamEffectiveLevel { get; set; }" +returns = "FileStreamEffectiveLevel?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "FilestreamShareName" +sig = "string FilestreamShareName { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "HadrManagerStatus" +sig = "HadrManagerStatus? HadrManagerStatus { get; set; }" +returns = "HadrManagerStatus?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "InstanceDefaultBackupPath" +sig = "string InstanceDefaultBackupPath { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "InstanceDefaultDataPath" +sig = "string InstanceDefaultDataPath { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "InstanceDefaultLogPath" +sig = "string InstanceDefaultLogPath { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "InstanceName" +sig = "string InstanceName { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "IsAdvancedAnalyticsInstalled" +sig = "bool? IsAdvancedAnalyticsInstalled { get; set; }" +returns = "bool?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "IsBigDataCluster" +sig = "bool? IsBigDataCluster { get; set; }" +returns = "bool?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "IsClustered" +sig = "bool? IsClustered { get; set; }" +returns = "bool?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "IsFullTextInstalled" +sig = "bool? IsFullTextInstalled { get; set; }" +returns = "bool?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "IsHadrEnabled" +sig = "bool? IsHadrEnabled { get; set; }" +returns = "bool?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "IsIntegratedSecurityOnly" +sig = "bool? IsIntegratedSecurityOnly { get; set; }" +returns = "bool?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "IsLocalDB" +sig = "bool IsLocalDB { get; set; }" +returns = "bool" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "IsPolyBaseInstalled" +sig = "bool? IsPolyBaseInstalled { get; set; }" +returns = "bool?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "IsSingleUser" +sig = "bool? IsSingleUser { get; set; }" +returns = "bool?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "IsTempDbMetadataMemoryOptimized" +sig = "bool? IsTempDbMetadataMemoryOptimized { get; set; }" +returns = "bool?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "IsXTPSupported" +sig = "bool? IsXTPSupported { get; set; }" +returns = "bool?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "LCID" +sig = "int? LCID { get; set; }" +returns = "int?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "LicenseType" +sig = "string LicenseType { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "MachineName" +sig = "string MachineName { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "NumLicenses" +sig = "string NumLicenses { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "ProcessID" +sig = "int? ProcessID { get; set; }" +returns = "int?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "ProductBuild" +sig = "string ProductBuild { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "ProductBuildType" +sig = "string ProductBuildType { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "ProductLevel" +sig = "string ProductLevel { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "ProductMajorVersion" +sig = "string ProductMajorVersion { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "ProductMinorVersion" +sig = "string ProductMinorVersion { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "ProductUpdateLevel" +sig = "string ProductUpdateLevel { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "ProductUpdateReference" +sig = "string ProductUpdateReference { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "ProductVersion" +sig = "Version ProductVersion { get; set; }" +returns = "Version" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "ResourceLastUpdateDateTime" +sig = "DateTime? ResourceLastUpdateDateTime { get; set; }" +returns = "DateTime?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "ResourceVersion" +sig = "Version ResourceVersion { get; set; }" +returns = "Version" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "ServerName" +sig = "string ServerName { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "SqlCharSet" +sig = "short? SqlCharSet { get; set; }" +returns = "short?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "SqlCharSetName" +sig = "string SqlCharSetName { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "SqlSortOrder" +sig = "short? SqlSortOrder { get; set; }" +returns = "short?" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "SqlSortOrderName" +sig = "string SqlSortOrderName { get; set; }" +returns = "string" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "LoginMode" +sig = "ServerLoginMode LoginMode { get; }" +returns = "ServerLoginMode" +file = "SQLInstanceInfo.cs" + +[[properties]] +parent = "SQLInstanceInfo" +name = "Server" +sig = "Server Server { get; set; }" +returns = "Server" +file = "SQLInstanceInfo.cs" + +[[ctors]] +parent = "SQLInstanceInfo" +sig = "SQLInstanceInfo(string instanceName)" +file = "SQLInstanceInfo.cs" + +[[methods]] +parent = "SQLInstanceInfo" +name = "LoadInfoAsync" +sig = "Task LoadInfoAsync()" +returns = "Task" +file = "SQLInstanceInfo.cs" + +[[methods]] +parent = "SQLInstanceInfo" +name = "LoadInfo" +sig = "bool LoadInfo()" +returns = "bool" +file = "SQLInstanceInfo.cs" + [[enums]] name = "ServerEditionID" ns = "FEx.Sqlx.Enums" @@ -34,15 +437,77 @@ ns = "FEx.Sqlx.Extensions" file = "Extensions\\SqlConnectionExtensions.cs" static = true +[[properties]] +parent = "SqlConnectionExtensions" +name = "ServerProps" +sig = "static IMap ServerProps { get; }" +returns = "IMap" +file = "Extensions\\SqlConnectionExtensions.cs" +static = true + +[[properties]] +parent = "SqlConnectionExtensions" +name = "ServerEditionIDs" +sig = "static IMap ServerEditionIDs { get; }" +returns = "IMap" +file = "Extensions\\SqlConnectionExtensions.cs" +static = true + +[[properties]] +parent = "SqlConnectionExtensions" +name = "ServerEngineEditions" +sig = "static IMap ServerEngineEditions { get; }" +returns = "IMap" +file = "Extensions\\SqlConnectionExtensions.cs" +static = true + +[[properties]] +parent = "SqlConnectionExtensions" +name = "PropsSQL" +sig = "static string PropsSQL { get; }" +returns = "string" +file = "Extensions\\SqlConnectionExtensions.cs" +static = true + +[[extensions]] +name = "RunSqlAsync" +returns = "Task[]>" +sig = "Task[]> RunSqlAsync(this MsSqlConnection connection, string sql)" +file = "Extensions\\SqlConnectionExtensions.cs" + +[[extensions]] +name = "RunSqlAsync" +returns = "Task[]>" +sig = "Task[]> RunSqlAsync(this SqlConnection connection, string sql)" +file = "Extensions\\SqlConnectionExtensions.cs" + [[extensions]] name = "RunSql" -sig = "IDictionary[] RunSql(this MsSqlConnection connection, string sql)" returns = "IDictionary[]" +sig = "IDictionary[] RunSql(this MsSqlConnection connection, string sql)" file = "Extensions\\SqlConnectionExtensions.cs" [[extensions]] name = "RunSql" -sig = "IDictionary[] RunSql(this SqlConnection connection, string sql)" returns = "IDictionary[]" +sig = "IDictionary[] RunSql(this SqlConnection connection, string sql)" +file = "Extensions\\SqlConnectionExtensions.cs" + +[[extensions]] +name = "LoadDatabasesAsync" +returns = "Task>" +sig = "Task> LoadDatabasesAsync(this SqlConnection connection)" +file = "Extensions\\SqlConnectionExtensions.cs" + +[[extensions]] +name = "LoadTablesAsync" +returns = "Task>" +sig = "Task> LoadTablesAsync(this SqlConnection connection)" +file = "Extensions\\SqlConnectionExtensions.cs" + +[[extensions]] +name = "LoadColumnsAsync" +returns = "Task<(long tableId, string[] columnNames)>" +sig = "Task<(long tableId, string[] columnNames)> LoadColumnsAsync( this SqlConnection connection, long tableId, IProgress prg = null)" file = "Extensions\\SqlConnectionExtensions.cs" diff --git a/.api-surface/FEx/Telemetry.Sentry.Web.toml b/.api-surface/FEx/Telemetry.Sentry.Web.toml index ff1f5075..ae5801b0 100644 --- a/.api-surface/FEx/Telemetry.Sentry.Web.toml +++ b/.api-surface/FEx/Telemetry.Sentry.Web.toml @@ -10,8 +10,7 @@ static = true [[extensions]] name = "AddFExSentry" -sig = "WebApplicationBuilder AddFExSentry(this WebApplicationBuilder builder, - string envVarOverride = \"SENTRY_DSN\")" returns = "WebApplicationBuilder" +sig = "WebApplicationBuilder AddFExSentry(this WebApplicationBuilder builder, string envVarOverride = \"SENTRY_DSN\")" file = "FExSentryWebExtensions.cs" diff --git a/.api-surface/FEx/Telemetry.Sentry.toml b/.api-surface/FEx/Telemetry.Sentry.toml index 7b9ee3f2..e7cf28cd 100644 --- a/.api-surface/FEx/Telemetry.Sentry.toml +++ b/.api-surface/FEx/Telemetry.Sentry.toml @@ -8,33 +8,103 @@ ns = "FEx.Telemetry.Sentry" base = "FExTelemetryConfigBase, ISentryConfig" file = "FExSentryConfig.cs" +[[properties]] +parent = "FExSentryConfig" +name = "SentryDsn" +sig = "string SentryDsn { get; }" +returns = "string" +file = "FExSentryConfig.cs" + +[[properties]] +parent = "FExSentryConfig" +name = "AttachScreenshot" +sig = "bool AttachScreenshot { get; }" +returns = "bool" +file = "FExSentryConfig.cs" + +[[properties]] +parent = "FExSentryConfig" +name = "EnvironmentId" +sig = "string EnvironmentId { get; }" +returns = "string" +file = "FExSentryConfig.cs" + +[[properties]] +parent = "FExSentryConfig" +name = "SentryEnvironment" +sig = "string SentryEnvironment { get; }" +returns = "string" +file = "FExSentryConfig.cs" + +[[ctors]] +parent = "FExSentryConfig" +sig = "FExSentryConfig(string dsn, string envVarOverride = \"SENTRY_DSN\")" +file = "FExSentryConfig.cs" + +[[methods]] +parent = "FExSentryConfig" +name = "OnAccessTokenChanged" +sig = "void OnAccessTokenChanged(string accessToken)" +returns = "void" +file = "FExSentryConfig.cs" + [[classes]] name = "FExSentryModule" ns = "FEx.Telemetry.Sentry" base = "FExTelemetryModule" file = "FExSentryModule.cs" +[[methods]] +parent = "FExSentryModule" +name = "AddServices" +sig = "static void AddServices(ISentryModule container, IServiceCollection services)" +returns = "void" +file = "FExSentryModule.cs" +static = true + [[classes]] name = "FExSentryx" ns = "FEx.Telemetry.Sentry" base = "InitializeModule" file = "FExSentryx.cs" +[[properties]] +parent = "FExSentryx" +name = "SentrySrv" +sig = "static ISentryService SentrySrv { get; }" +returns = "ISentryService" +file = "FExSentryx.cs" +static = true + +[[ctors]] +parent = "FExSentryx" +sig = "FExSentryx(ISentryService sentrySrv)" +file = "FExSentryx.cs" + +[[methods]] +parent = "FExSentryx" +name = "RegisterServices" +sig = "void RegisterServices(ISentryModule container, IServiceCollection services)" +returns = "void" +file = "FExSentryx.cs" + [[classes]] name = "SentrySinkConfigurator" ns = "FEx.Telemetry.Sentry" base = "SentrySinkConfiguratorBase" file = "SentrySinkConfigurator.cs" -[[interfaces]] -name = "ISentryModule" -ns = "FEx.Telemetry.Sentry.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\ISentryModule.cs" +[[ctors]] +parent = "SentrySinkConfigurator" +sig = "SentrySinkConfigurator(ISentryConfig sentryConfig, ILoggingConfiguration loggingConfiguration, IAppVersionProvider appVersionProvider)" +file = "SentrySinkConfigurator.cs" -[[interfaces]] -name = "ISentryService" -ns = "FEx.Telemetry.Sentry.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\ISentryService.cs" +[[methods]] +parent = "SentrySinkConfigurator" +name = "ConfigureSink" +sig = "LoggerConfiguration ConfigureSink(LoggerSinkConfiguration writeTo)" +returns = "LoggerConfiguration" +file = "SentrySinkConfigurator.cs" [[classes]] name = "SentryConfigBase" @@ -42,6 +112,27 @@ ns = "FEx.Telemetry.Sentry.Configuration" base = "ISentryConfig" file = "Configuration\\SentryConfigBase.cs" +[[properties]] +parent = "SentryConfigBase" +name = "SentryDsn" +sig = "string SentryDsn { get; }" +returns = "string" +file = "Configuration\\SentryConfigBase.cs" + +[[properties]] +parent = "SentryConfigBase" +name = "AttachScreenshot" +sig = "bool AttachScreenshot { get; }" +returns = "bool" +file = "Configuration\\SentryConfigBase.cs" + +[[properties]] +parent = "SentryConfigBase" +name = "EnvironmentId" +sig = "string EnvironmentId { get; }" +returns = "string" +file = "Configuration\\SentryConfigBase.cs" + [[classes]] name = "SentryServiceExtensions" ns = "FEx.Telemetry.Sentry.Extensions" @@ -50,8 +141,8 @@ static = true [[extensions]] name = "InitializeFromConfig" -sig = "void InitializeFromConfig(this ISentryService service, FExSentryConfig config, Assembly appAssembly)" returns = "void" +sig = "void InitializeFromConfig(this ISentryService service, FExSentryConfig config, Assembly appAssembly)" file = "Extensions\\SentryServiceExtensions.cs" [[classes]] @@ -60,3 +151,77 @@ ns = "FEx.Telemetry.Sentry.Services" base = "ISentryService, IDisposable" file = "Services\\SentryService.cs" +[[properties]] +parent = "SentryService" +name = "IsInitialized" +sig = "bool IsInitialized { get; }" +returns = "bool" +file = "Services\\SentryService.cs" + +[[methods]] +parent = "SentryService" +name = "Initialize" +sig = "void Initialize(string dsn, string environment, string release)" +returns = "void" +file = "Services\\SentryService.cs" + +[[methods]] +parent = "SentryService" +name = "CaptureException" +sig = "void CaptureException(Exception exception)" +returns = "void" +file = "Services\\SentryService.cs" + +[[methods]] +parent = "SentryService" +name = "FlushAsync" +sig = "Task FlushAsync(TimeSpan? timeout = null)" +returns = "Task" +file = "Services\\SentryService.cs" + +[[methods]] +parent = "SentryService" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Services\\SentryService.cs" + +[[interfaces]] +name = "ISentryModule" +ns = "FEx.Telemetry.Sentry.Abstractions.Interfaces" +base = "IFExTelemetryModule, IContainer, IContainer" +file = "Abstractions\\Interfaces\\ISentryModule.cs" + +[[interfaces]] +name = "ISentryService" +ns = "FEx.Telemetry.Sentry.Abstractions.Interfaces" +file = "Abstractions\\Interfaces\\ISentryService.cs" + +[[properties]] +parent = "ISentryService" +name = "IsInitialized" +sig = "bool IsInitialized { get; }" +returns = "bool" +file = "Abstractions\\Interfaces\\ISentryService.cs" + +[[methods]] +parent = "ISentryService" +name = "Initialize" +sig = "void Initialize(string dsn, string environment, string release)" +returns = "void" +file = "Abstractions\\Interfaces\\ISentryService.cs" + +[[methods]] +parent = "ISentryService" +name = "CaptureException" +sig = "void CaptureException(Exception exception)" +returns = "void" +file = "Abstractions\\Interfaces\\ISentryService.cs" + +[[methods]] +parent = "ISentryService" +name = "FlushAsync" +sig = "Task FlushAsync(TimeSpan? timeout = null)" +returns = "Task" +file = "Abstractions\\Interfaces\\ISentryService.cs" + diff --git a/.api-surface/FEx/Telemetry.toml b/.api-surface/FEx/Telemetry.toml index c7ecbc2c..2ab47410 100644 --- a/.api-surface/FEx/Telemetry.toml +++ b/.api-surface/FEx/Telemetry.toml @@ -8,6 +8,60 @@ ns = "FEx.Telemetry" base = "NotifyPropertyChanged, IFExTelemetryConfig" file = "FExTelemetryConfigBase.cs" +[[properties]] +parent = "FExTelemetryConfigBase" +name = "AccessToken" +sig = "string AccessToken { get; set; }" +returns = "string" +file = "FExTelemetryConfigBase.cs" + +[[properties]] +parent = "FExTelemetryConfigBase" +name = "AppEnvironment" +sig = "string AppEnvironment { get; }" +returns = "string" +file = "FExTelemetryConfigBase.cs" + +[[properties]] +parent = "FExTelemetryConfigBase" +name = "PersonEmail" +sig = "Func PersonEmail { get; set; }" +returns = "Func" +file = "FExTelemetryConfigBase.cs" + +[[properties]] +parent = "FExTelemetryConfigBase" +name = "PersonUserName" +sig = "Func PersonUserName { get; set; }" +returns = "Func" +file = "FExTelemetryConfigBase.cs" + +[[properties]] +parent = "FExTelemetryConfigBase" +name = "AddPersonToEnvironment" +sig = "bool AddPersonToEnvironment { get; set; }" +returns = "bool" +file = "FExTelemetryConfigBase.cs" + +[[properties]] +parent = "FExTelemetryConfigBase" +name = "EnvironmentParam" +sig = "string EnvironmentParam { get; }" +returns = "string" +file = "FExTelemetryConfigBase.cs" + +[[ctors]] +parent = "FExTelemetryConfigBase" +sig = "FExTelemetryConfigBase()" +file = "FExTelemetryConfigBase.cs" + +[[methods]] +parent = "FExTelemetryConfigBase" +name = "OnAccessTokenChanged" +sig = "void OnAccessTokenChanged(string accessToken)" +returns = "void" +file = "FExTelemetryConfigBase.cs" + [[classes]] name = "FExTelemetryModule" ns = "FEx.Telemetry" @@ -18,9 +72,45 @@ name = "IFExTelemetryConfig" ns = "FEx.Telemetry" file = "IFExTelemetryConfig.cs" +[[properties]] +parent = "IFExTelemetryConfig" +name = "AccessToken" +sig = "string AccessToken { get; set; }" +returns = "string" +file = "IFExTelemetryConfig.cs" + +[[properties]] +parent = "IFExTelemetryConfig" +name = "AppEnvironment" +sig = "string AppEnvironment { get; }" +returns = "string" +file = "IFExTelemetryConfig.cs" + +[[properties]] +parent = "IFExTelemetryConfig" +name = "PersonEmail" +sig = "Func PersonEmail { get; set; }" +returns = "Func" +file = "IFExTelemetryConfig.cs" + +[[properties]] +parent = "IFExTelemetryConfig" +name = "PersonUserName" +sig = "Func PersonUserName { get; set; }" +returns = "Func" +file = "IFExTelemetryConfig.cs" + +[[properties]] +parent = "IFExTelemetryConfig" +name = "AddPersonToEnvironment" +sig = "bool AddPersonToEnvironment { get; set; }" +returns = "bool" +file = "IFExTelemetryConfig.cs" + [[interfaces]] name = "IFExTelemetryModule" ns = "FEx.Telemetry" +base = "IContainer, IContainer" file = "IFExTelemetryModule.cs" [[classes]] diff --git a/.api-surface/FEx/WPFx.toml b/.api-surface/FEx/WPFx.toml index e838a60e..8bf926cd 100644 --- a/.api-surface/FEx/WPFx.toml +++ b/.api-surface/FEx/WPFx.toml @@ -8,65 +8,398 @@ ns = "FEx.WPFx" base = "InitializeModule" file = "FExModule.cs" +[[methods]] +parent = "FExModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExContainer container, IServiceCollection context)" +returns = "void" +file = "FExModule.cs" + [[classes]] name = "FExWpfx" ns = "FEx.WPFx" base = "FExInitializable" file = "FExWPFx.cs" +[[properties]] +parent = "FExWpfx" +name = "ExcludedWindows" +sig = "static List ExcludedWindows { get; }" +returns = "List" +file = "FExWPFx.cs" +static = true + +[[properties]] +parent = "FExWpfx" +name = "CloseString" +sig = "static string CloseString { get; set; }" +returns = "string" +file = "FExWPFx.cs" +static = true + +[[properties]] +parent = "FExWpfx" +name = "MinimizeString" +sig = "static string MinimizeString { get; set; }" +returns = "string" +file = "FExWPFx.cs" +static = true + +[[properties]] +parent = "FExWpfx" +name = "RestoreString" +sig = "static string RestoreString { get; set; }" +returns = "string" +file = "FExWPFx.cs" +static = true + +[[properties]] +parent = "FExWpfx" +name = "MaximizeString" +sig = "static string MaximizeString { get; set; }" +returns = "string" +file = "FExWPFx.cs" +static = true + +[[properties]] +parent = "FExWpfx" +name = "ShowSystemMenuString" +sig = "static string ShowSystemMenuString { get; set; }" +returns = "string" +file = "FExWPFx.cs" +static = true + +[[properties]] +parent = "FExWpfx" +name = "IsMainWindowInitialized" +sig = "static bool IsMainWindowInitialized { get; }" +returns = "bool" +file = "FExWPFx.cs" +static = true + +[[properties]] +parent = "FExWpfx" +name = "Splash" +sig = "static Splash Splash { get; }" +returns = "Splash" +file = "FExWPFx.cs" +static = true + +[[properties]] +parent = "FExWpfx" +name = "AppConfig" +sig = "static IAppConfig AppConfig { get; }" +returns = "IAppConfig" +file = "FExWPFx.cs" +static = true + +[[ctors]] +parent = "FExWpfx" +sig = "FExWpfx(IAppConfig appConfig, Splash splash)" +file = "FExWPFx.cs" + +[[methods]] +parent = "FExWpfx" +name = "OverrideFormattingOnUI" +sig = "static void OverrideFormattingOnUI()" +returns = "void" +summary = "Overrides formatting on UI." +file = "FExWPFx.cs" +static = true + +[[methods]] +parent = "FExWpfx" +name = "OverrideFormattingOnUI" +sig = "static void OverrideFormattingOnUI(CultureInfo culture)" +returns = "void" +file = "FExWPFx.cs" +static = true + +[[methods]] +parent = "FExWpfx" +name = "OnInitialize" +sig = "void OnInitialize()" +returns = "void" +file = "FExWPFx.cs" + [[classes]] name = "FExWpfxModule" ns = "FEx.WPFx" base = "InitializeModule" file = "FExWPFxModule.cs" +[[properties]] +parent = "FExWpfxModule" +name = "AppConfig" +sig = "static IAppConfig AppConfig { get; }" +returns = "IAppConfig" +file = "FExWPFxModule.cs" +static = true + +[[methods]] +parent = "FExWpfxModule" +name = "RegisterServices" +sig = "void RegisterServices(IFExWpfxContainer container, IServiceCollection services)" +returns = "void" +file = "FExWPFxModule.cs" + [[classes]] name = "FileSystemIconsProvider" ns = "FEx.WPFx" file = "FileSystemIconsProvider.cs" +[[ctors]] +parent = "FileSystemIconsProvider" +sig = "FileSystemIconsProvider(ISynchronizedAccessService synchronizedAccessService, IFExMemoryCache iconsCache, IFExDispatcher dispatcher)" +file = "FileSystemIconsProvider.cs" + +[[methods]] +parent = "FileSystemIconsProvider" +name = "GetFileIconAsync" +sig = "Task GetFileIconAsync(string filePath)" +returns = "Task" +file = "FileSystemIconsProvider.cs" + +[[methods]] +parent = "FileSystemIconsProvider" +name = "GetFileIconAsync" +sig = "Task GetFileIconAsync(string filePath, bool isIconAttachedToFile)" +returns = "Task" +file = "FileSystemIconsProvider.cs" + [[classes]] name = "Splash" ns = "FEx.WPFx" base = "FExInitializable, IFExPriorityInitialize" file = "Splash.cs" +[[properties]] +parent = "Splash" +name = "SplashTask" +sig = "Task SplashTask { get; }" +returns = "Task" +file = "Splash.cs" + +[[properties]] +parent = "Splash" +name = "Priority" +sig = "int Priority { get; }" +returns = "int" +file = "Splash.cs" + +[[ctors]] +parent = "Splash" +sig = "Splash(IAppConfig appConfig, IAsyncHelper asyncHelper, IStatusService statusService)" +file = "Splash.cs" + +[[methods]] +parent = "Splash" +name = "Close" +sig = "static void Close()" +returns = "void" +file = "Splash.cs" +static = true + +[[methods]] +parent = "Splash" +name = "WaitForSplashAndClose" +sig = "void WaitForSplashAndClose()" +returns = "void" +file = "Splash.cs" + +[[methods]] +parent = "Splash" +name = "ShowSplash" +sig = "void ShowSplash()" +returns = "void" +file = "Splash.cs" + +[[methods]] +parent = "Splash" +name = "OnInitialize" +sig = "void OnInitialize()" +returns = "void" +file = "Splash.cs" + [[classes]] name = "AppBootstrapper" ns = "FEx.WPFx.Abstractions" -base = "Application - where TContainer : class, IFExContainer, IDisposable, new()" +base = "Application" file = "Abstractions\\AppBootstrapper.cs" -[[interfaces]] -name = "IAppConfig" -ns = "FEx.WPFx.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IAppConfig.cs" +[[properties]] +parent = "AppBootstrapper" +name = "AppData" +sig = "DirectoryInfo AppData { get; }" +returns = "DirectoryInfo" +file = "Abstractions\\AppBootstrapper.cs" -[[interfaces]] -name = "IFExContainer" -ns = "FEx.WPFx.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IFExContainer.cs" +[[properties]] +parent = "AppBootstrapper" +name = "UserData" +sig = "DirectoryInfo UserData { get; }" +returns = "DirectoryInfo" +file = "Abstractions\\AppBootstrapper.cs" -[[interfaces]] -name = "IFExWpfxContainer" -ns = "FEx.WPFx.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IFExWpfxContainer.cs" +[[properties]] +parent = "AppBootstrapper" +name = "UserSettingsPath" +sig = "string UserSettingsPath { get; }" +returns = "string" +file = "Abstractions\\AppBootstrapper.cs" -[[interfaces]] -name = "ITreeViewBuilder" -ns = "FEx.WPFx.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\ITreeViewBuilder.cs" +[[properties]] +parent = "AppBootstrapper" +name = "ApplicationName" +sig = "string ApplicationName { get; }" +returns = "string" +file = "Abstractions\\AppBootstrapper.cs" -[[interfaces]] -name = "ITreeViewBuilder" -ns = "FEx.WPFx.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\ITreeViewBuilder.cs" +[[ctors]] +parent = "AppBootstrapper" +sig = "AppBootstrapper()" +file = "Abstractions\\AppBootstrapper.cs" -[[interfaces]] -name = "IViewDesign" -ns = "FEx.WPFx.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IViewDesign.cs" +[[methods]] +parent = "AppBootstrapper" +name = "ComponentInitialize" +sig = "void ComponentInitialize()" +returns = "void" +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "OnActivation" +sig = "void OnActivation()" +returns = "void" +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "AfterServicesContainerBuild" +sig = "void AfterServicesContainerBuild()" +returns = "void" +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "SetNetwork" +sig = "void SetNetwork()" +returns = "void" +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "HandleException" +sig = "void HandleException(Exception exception)" +returns = "void" +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "BeforeStartup" +sig = "void BeforeStartup(StartupEventArgs e)" +returns = "void" +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "ExitIfInitializationHasFailed" +sig = "void ExitIfInitializationHasFailed()" +returns = "void" +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "ExitIfInitializationHasFailed" +sig = "void ExitIfInitializationHasFailed(int exitCode)" +returns = "void" +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "ExitApp" +sig = "void ExitApp()" +returns = "void" +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "ExitApp" +sig = "void ExitApp(int exitCode)" +returns = "void" +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "HasInitializationFailed" +sig = "bool HasInitializationFailed()" +returns = "bool" +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "AfterStartup" +sig = "void AfterStartup(StartupEventArgs e)" +returns = "void" +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "OnConstruction" +sig = "void OnConstruction(StartupEventArgs e)" +returns = "void" +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "OnAppDispatcherUnhandledException" +sig = "void OnAppDispatcherUnhandledException(object sender, DispatcherUnhandledExceptionEventArgs e)" +returns = "void" +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "AppDomainUnhandledException" +sig = "void AppDomainUnhandledException(object sender, UnhandledExceptionEventArgs e)" +returns = "void" +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "BeforeInitializationCheck" +sig = "void BeforeInitializationCheck()" +returns = "void" +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "EnsureSingleInstance" +sig = "void EnsureSingleInstance()" +returns = "void" +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "OnStartup" +sig = "void OnStartup(StartupEventArgs e)" +returns = "void" +summary = "Raises the event." +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "OnExit" +sig = "void OnExit(ExitEventArgs e)" +returns = "void" +file = "Abstractions\\AppBootstrapper.cs" + +[[methods]] +parent = "AppBootstrapper" +name = "LogToHub" +sig = "DisposableAction LogToHub(string status)" +returns = "DisposableAction" +file = "Abstractions\\AppBootstrapper.cs" [[classes]] name = "HotkeyActionAttribute" @@ -74,6 +407,30 @@ ns = "FEx.WPFx.Attributes" base = "Attribute" file = "Attributes\\HotkeyActionAttribute.cs" +[[properties]] +parent = "HotkeyActionAttribute" +name = "Key" +sig = "Key Key { get; }" +returns = "Key" +file = "Attributes\\HotkeyActionAttribute.cs" + +[[properties]] +parent = "HotkeyActionAttribute" +name = "Modifiers" +sig = "ModifierKeys Modifiers { get; }" +returns = "ModifierKeys" +file = "Attributes\\HotkeyActionAttribute.cs" + +[[ctors]] +parent = "HotkeyActionAttribute" +sig = "HotkeyActionAttribute(Key key)" +file = "Attributes\\HotkeyActionAttribute.cs" + +[[ctors]] +parent = "HotkeyActionAttribute" +sig = "HotkeyActionAttribute(Key key, ModifierKeys modifiers)" +file = "Attributes\\HotkeyActionAttribute.cs" + [[classes]] name = "IconAttribute" ns = "FEx.WPFx.Attributes" @@ -81,6 +438,36 @@ base = "Attribute" summary = "Base icon attribute." file = "Attributes\\IconAttribute.cs" +[[properties]] +parent = "IconAttribute" +name = "Icon" +sig = "Enum Icon { get; }" +returns = "Enum" +summary = "Gets the icon." +file = "Attributes\\IconAttribute.cs" + +[[properties]] +parent = "IconAttribute" +name = "Character" +sig = "char Character { get; }" +returns = "char" +summary = "Gets the character." +file = "Attributes\\IconAttribute.cs" + +[[properties]] +parent = "IconAttribute" +name = "AltText" +sig = "string AltText { get; }" +returns = "string" +summary = "Gets the alt text." +file = "Attributes\\IconAttribute.cs" + +[[ctors]] +parent = "IconAttribute" +sig = "IconAttribute(Enum icon)" +summary = "Initializes a new instance of the IconAttribute class." +file = "Attributes\\IconAttribute.cs" + [[classes]] name = "IconDescriptorAttribute" ns = "FEx.WPFx.Attributes" @@ -88,23 +475,97 @@ base = "Attribute" summary = "Icon character attribute." file = "Attributes\\IconDescriptorAttribute.cs" +[[properties]] +parent = "IconDescriptorAttribute" +name = "Character" +sig = "char Character { get; }" +returns = "char" +summary = "Gets the value." +file = "Attributes\\IconDescriptorAttribute.cs" + +[[properties]] +parent = "IconDescriptorAttribute" +name = "AltText" +sig = "string AltText { get; }" +returns = "string" +summary = "Gets the alt text." +file = "Attributes\\IconDescriptorAttribute.cs" + +[[ctors]] +parent = "IconDescriptorAttribute" +sig = "IconDescriptorAttribute(char character, string altText = null)" +summary = "Initializes a new instance of the IconCharacterAttribute class." +file = "Attributes\\IconDescriptorAttribute.cs" + [[classes]] name = "DataGridBehavior" ns = "FEx.WPFx.Behaviors" file = "Behaviors\\DataGridBehavior.cs" static = true +[[methods]] +parent = "DataGridBehavior" +name = "GetDisplayRowNumber" +sig = "static bool GetDisplayRowNumber(DependencyObject target)" +returns = "bool" +file = "Behaviors\\DataGridBehavior.cs" +static = true + +[[methods]] +parent = "DataGridBehavior" +name = "SetDisplayRowNumber" +sig = "static void SetDisplayRowNumber(DependencyObject target, bool value)" +returns = "void" +file = "Behaviors\\DataGridBehavior.cs" +static = true + +[[extensions]] +name = "GetVisualChildCollection" +returns = "List" +sig = "List GetVisualChildCollection(this DependencyObject parent)" +file = "Behaviors\\DataGridBehavior.cs" + [[classes]] name = "TextBoxBehavior" ns = "FEx.WPFx.Behaviors" file = "Behaviors\\TextBoxBehavior.cs" +[[methods]] +parent = "TextBoxBehavior" +name = "GetSelectAllTextOnFocus" +sig = "static bool GetSelectAllTextOnFocus(TextBox textBox)" +returns = "bool" +file = "Behaviors\\TextBoxBehavior.cs" +static = true + +[[methods]] +parent = "TextBoxBehavior" +name = "SetSelectAllTextOnFocus" +sig = "static void SetSelectAllTextOnFocus(TextBox textBox, bool value)" +returns = "void" +file = "Behaviors\\TextBoxBehavior.cs" +static = true + [[classes]] name = "BindingProxy" ns = "FEx.WPFx.Controls" base = "Freezable" file = "Controls\\BindingProxy.cs" +[[properties]] +parent = "BindingProxy" +name = "Data" +sig = "object Data { get; set; }" +returns = "object" +file = "Controls\\BindingProxy.cs" + +[[methods]] +parent = "BindingProxy" +name = "CreateInstanceCore" +sig = "Freezable CreateInstanceCore()" +returns = "Freezable" +file = "Controls\\BindingProxy.cs" + [[classes]] name = "BusyIndicator" ns = "FEx.WPFx.Controls" @@ -112,6 +573,25 @@ base = "ContentControl" summary = "Interaction logic for BusyIndicator.xaml" file = "Controls\\BusyIndicator.xaml.cs" +[[properties]] +parent = "BusyIndicator" +name = "IsBusy" +sig = "bool IsBusy { get; set; }" +returns = "bool" +file = "Controls\\BusyIndicator.xaml.cs" + +[[properties]] +parent = "BusyIndicator" +name = "BusyContent" +sig = "object BusyContent { get; set; }" +returns = "object" +file = "Controls\\BusyIndicator.xaml.cs" + +[[ctors]] +parent = "BusyIndicator" +sig = "BusyIndicator()" +file = "Controls\\BusyIndicator.xaml.cs" + [[classes]] name = "ControlsHandler" ns = "FEx.WPFx.Controls" @@ -120,66 +600,64 @@ static = true [[extensions]] name = "ApplySortDescriptions" -sig = "void ApplySortDescriptions(this DataGrid dataGrid, - DataGridColumn col, - string sortPropertyName, - ListSortDirection listSortDirection, - bool clear = true)" returns = "void" +sig = "void ApplySortDescriptions(this DataGrid dataGrid, DataGridColumn col, string sortPropertyName, ListSortDirection listSortDirection, bool clear = true)" file = "Controls\\ControlsHandler.cs" [[extensions]] name = "ApplySortDescriptions" -sig = "void ApplySortDescriptions(this DataGrid dataGrid, - string columnName, - ListSortDirection listSortDirection, - bool clear = true)" returns = "void" +sig = "void ApplySortDescriptions(this DataGrid dataGrid, string columnName, ListSortDirection listSortDirection, bool clear = true)" file = "Controls\\ControlsHandler.cs" [[extensions]] name = "ApplySortDescriptions" -sig = "void ApplySortDescriptions(this DataGrid dataGrid, - DataGridColumn column, - ListSortDirection listSortDirection, - bool clear = true)" returns = "void" +sig = "void ApplySortDescriptions(this DataGrid dataGrid, DataGridColumn column, ListSortDirection listSortDirection, bool clear = true)" file = "Controls\\ControlsHandler.cs" [[extensions]] name = "GetSortPropertyName" -sig = "string GetSortPropertyName(this DataGridColumn col)" returns = "string" +sig = "string GetSortPropertyName(this DataGridColumn col)" file = "Controls\\ControlsHandler.cs" [[extensions]] name = "GetColumnIndex" -sig = "int GetColumnIndex(this DataGrid dataGrid, string columnName)" returns = "int" +sig = "int GetColumnIndex(this DataGrid dataGrid, string columnName)" file = "Controls\\ControlsHandler.cs" [[extensions]] name = "GetColumnHeader" -sig = "string GetColumnHeader(this DataGridColumn col)" returns = "string" +sig = "string GetColumnHeader(this DataGridColumn col)" file = "Controls\\ControlsHandler.cs" [[extensions]] name = "GetColumnHeader" +returns = "string" sig = "string GetColumnHeader(this GridViewColumn col)" +file = "Controls\\ControlsHandler.cs" + +[[methods]] +parent = "ControlsHandler" +name = "GetColumnHeader" +sig = "static string GetColumnHeader(object colHeader)" returns = "string" file = "Controls\\ControlsHandler.cs" +static = true [[extensions]] name = "ClearSortDirections" -sig = "void ClearSortDirections(this DataGrid dataGrid)" returns = "void" +sig = "void ClearSortDirections(this DataGrid dataGrid)" file = "Controls\\ControlsHandler.cs" [[extensions]] name = "SetColumnVisibility" -sig = "void SetColumnVisibility(this DataGrid dataGrid, string columnName, bool visible)" returns = "void" +sig = "void SetColumnVisibility(this DataGrid dataGrid, string columnName, bool visible)" file = "Controls\\ControlsHandler.cs" [[classes]] @@ -188,10 +666,20 @@ ns = "FEx.WPFx.Controls" base = "ResourceDictionary" file = "Controls\\DesignTimeResourceDictionary.cs" +[[ctors]] +parent = "DesignTimeResourceDictionary" +sig = "DesignTimeResourceDictionary()" +file = "Controls\\DesignTimeResourceDictionary.cs" + [[classes]] name = "FExShellWindow" ns = "FEx.WPFx.Controls" -base = "FExWindow where TViewModel : WpfProgressListenerViewModel" +base = "FExWindow" +file = "Controls\\FExShellWindow.cs" + +[[ctors]] +parent = "FExShellWindow" +sig = "FExShellWindow()" file = "Controls\\FExShellWindow.cs" [[classes]] @@ -200,873 +688,6118 @@ ns = "FEx.WPFx.Controls" base = "UserControl, IFExNotifyPropertyChanged" file = "Controls\\FExUserControl.cs" -[[classes]] -name = "FExWindow" -ns = "FEx.WPFx.Controls" -base = "Window, IViewFor, IRunAsyncView - where TViewModel : WpfProgressListenerViewModel" -file = "Controls\\FExWindow.cs" +[[properties]] +parent = "FExUserControl" +name = "Subscriptions" +sig = "ConcurrentDictionary Subscriptions { get; }" +returns = "ConcurrentDictionary" +file = "Controls\\FExUserControl.cs" -[[classes]] -name = "IconDisplayer" -ns = "FEx.WPFx.Controls" -base = "TextBlock" -summary = "Icon displayer control." -file = "Controls\\IconDisplayer.cs" +[[properties]] +parent = "FExUserControl" +name = "IsInDesignMode" +sig = "bool IsInDesignMode { get; }" +returns = "bool" +file = "Controls\\FExUserControl.cs" -[[classes]] -name = "OutlinedTextBlock" -ns = "FEx.WPFx.Controls" -base = "FrameworkElement" -file = "Controls\\OutlinedTextBlock.cs" +[[ctors]] +parent = "FExUserControl" +sig = "FExUserControl()" +file = "Controls\\FExUserControl.cs" -[[classes]] -name = "SplashScreenWindow" -ns = "FEx.WPFx.Controls" -base = "Window, INotifyPropertyChanged" -summary = "Interaction logic for MainWindow.xaml" -file = "Controls\\SplashScreenWindow.xaml.cs" +[[methods]] +parent = "FExUserControl" +name = "OnPropertiesChanged" +sig = "void OnPropertiesChanged(params string[] propertyNames)" +returns = "void" +file = "Controls\\FExUserControl.cs" -[[classes]] -name = "TreeViewBuilder" -ns = "FEx.WPFx.Controls" -base = "TreeViewBuilderBase" -file = "Controls\\TreeViewBuilder.cs" +[[methods]] +parent = "FExUserControl" +name = "OnPropertyChanged" +sig = "void OnPropertyChanged([CallerMemberName] string propertyName = null)" +returns = "void" +file = "Controls\\FExUserControl.cs" -[[classes]] -name = "TreeViewBuilderBase" -ns = "FEx.WPFx.Controls" -base = "ITreeViewBuilder where TItem : HeaderedItemsControl, new()" -file = "Controls\\TreeViewBuilderBase.cs" +[[methods]] +parent = "FExUserControl" +name = "SetProperty" +sig = "bool SetProperty(ref TRet backingField, TRet newValue, Action onPropertyChanged = null, [CallerMemberName] string propertyName = null)" +returns = "bool" +file = "Controls\\FExUserControl.cs" -[[classes]] -name = "VerticalTextBlock" -ns = "FEx.WPFx.Controls" -base = "TextBlock" -file = "Controls\\VerticalTextBlock.cs" +[[methods]] +parent = "FExUserControl" +name = "OnPropertySet" +sig = "void OnPropertySet(T oldValue, T newValue, string propertyName)" +returns = "void" +file = "Controls\\FExUserControl.cs" -[[classes]] -name = "ZoomBorder" -ns = "FEx.WPFx.Controls" -base = "Border, INotifyPropertyChanged" -file = "Controls\\ZoomBorder.cs" +[[methods]] +parent = "FExUserControl" +name = "RunAsync" +sig = "Task RunAsync(T viewModel, Action action, object sender = null, JobSpecs? specs = null) where T : IThreadingAwareViewModel" +returns = "Task" +file = "Controls\\FExUserControl.cs" -[[classes]] -name = "VirtualizingPanelWrapper" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -base = "IChildrenCollection" -file = "Controls\\VirtualizingWrapPanelControl\\ChildrenCollection.cs" +[[methods]] +parent = "FExUserControl" +name = "RunTaskAsync" +sig = "Task RunTaskAsync(T viewModel, Func function, object sender = null, JobSpecs? specs = null) where T : IThreadingAwareViewModel" +returns = "Task" +file = "Controls\\FExUserControl.cs" -[[interfaces]] -name = "IChildrenCollection" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -file = "Controls\\VirtualizingWrapPanelControl\\ChildrenCollection.cs" +[[methods]] +parent = "FExUserControl" +name = "RunTaskAsync" +sig = "Task RunTaskAsync(T viewModel, Func> function, object sender = null, JobSpecs? specs = null) where T : IThreadingAwareViewModel" +returns = "Task" +file = "Controls\\FExUserControl.cs" -[[classes]] -name = "GridDetailsView" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -base = "GridView" -summary = "Simple control that displays a gird of items. Depending on the orientation, the items are either stacked horizontally or vertically until the items are wrapped to the next row or column. The control is using virtualization to support large amount of items. If an item is clicked the item gots expanded until it is clicked again or an other item is clicked and gots expanded. In order to work properly all items must have the same size." -file = "Controls\\VirtualizingWrapPanelControl\\GridDetailsView.xaml.cs" +[[methods]] +parent = "FExUserControl" +name = "RunFuncAsync" +sig = "Task RunFuncAsync(T viewModel, Func function, object sender = null, JobSpecs? specs = null) where T : IThreadingAwareViewModel" +returns = "Task" +file = "Controls\\FExUserControl.cs" -[[classes]] -name = "GridView" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -base = "ListView" -summary = "Simple control that displays a gird of items. Depending on the orientation, the items are either stacked horizontally or vertically until the items are wrapped to the next row or column. The control is using virtualization to support large amount of items. In order to work properly all items must have the same size." -file = "Controls\\VirtualizingWrapPanelControl\\GridView.cs" +[[methods]] +parent = "FExUserControl" +name = "PreAction" +sig = "void PreAction(object sender)" +returns = "void" +file = "Controls\\FExUserControl.cs" -[[interfaces]] -name = "IItemSizeProvider" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -summary = "Provides the size of items displayed in an VirtualizingPanel." -file = "Controls\\VirtualizingWrapPanelControl\\IItemSizeProvider.cs" +[[methods]] +parent = "FExUserControl" +name = "PostAction" +sig = "void PostAction(object sender, bool isSuccess)" +returns = "void" +file = "Controls\\FExUserControl.cs" [[classes]] -name = "ItemContainerInfo" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -base = "IItemContainerInfo" -file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" +name = "FExWindow" +ns = "FEx.WPFx.Controls" +base = "Window, IViewFor, IRunAsyncView" +file = "Controls\\FExWindow.cs" -[[interfaces]] -name = "IItemContainerInfo" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" +[[properties]] +parent = "FExWindow" +name = "ViewModelProperty" +sig = "static DependencyProperty ViewModelProperty { get; }" +returns = "DependencyProperty" +file = "Controls\\FExWindow.cs" +static = true -[[classes]] -name = "ItemContainerManagerItemsChangedEventArgs" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" +[[properties]] +parent = "FExWindow" +name = "IsInDesignMode" +sig = "bool IsInDesignMode { get; }" +returns = "bool" +file = "Controls\\FExWindow.cs" -[[classes]] -name = "ItemContainerManager" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -base = "IItemContainerManager" -summary = "Realizes the specified item. If the item is already realized, nothing happens." -file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" +[[properties]] +parent = "FExWindow" +name = "MainGrid" +sig = "Grid MainGrid { get; set; }" +returns = "Grid" +file = "Controls\\FExWindow.cs" -[[interfaces]] -name = "IItemContainerManager" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" +[[properties]] +parent = "FExWindow" +name = "DisplayScreen" +sig = "Screen DisplayScreen { get; set; }" +returns = "Screen" +file = "Controls\\FExWindow.cs" -[[enums]] -name = "ScrollDirection" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -file = "Controls\\VirtualizingWrapPanelControl\\ScrollDirection.cs" +[[properties]] +parent = "FExWindow" +name = "ViewModel" +sig = "TViewModel ViewModel { get; set; }" +returns = "TViewModel" +file = "Controls\\FExWindow.cs" -[[enums]] -name = "SpacingMode" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -summary = "Specifies how remaining space is distributed." -file = "Controls\\VirtualizingWrapPanelControl\\SpacingMode.cs" +[[properties]] +parent = "FExWindow" +name = "FixedWidth" +sig = "double FixedWidth { get; set; }" +returns = "double" +file = "Controls\\FExWindow.cs" -[[classes]] -name = "VirtualizingItemsControl" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -base = "ItemsControl" -summary = "A ItemsControl supporting virtualization." -file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingItemsControl.cs" +[[ctors]] +parent = "FExWindow" +sig = "FExWindow()" +file = "Controls\\FExWindow.cs" -[[classes]] -name = "VirtualizingPanelBase" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -base = "VirtualizingPanel, IScrollInfo" -summary = "Base class for panels which are supporting virtualization." -file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" +[[methods]] +parent = "FExWindow" +name = "RunAsync" +sig = "Task RunAsync(Action action, object sender = null, JobSpecs? specs = null)" +returns = "Task" +file = "Controls\\FExWindow.cs" -[[classes]] -name = "VirtualizingPanelBaseV1" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -base = "VirtualizingPanel, IScrollInfo" -summary = "Base class for panels which are supporting virtualization." -file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" +[[methods]] +parent = "FExWindow" +name = "RunTaskAsync" +sig = "Task RunTaskAsync(Func function, object sender = null, JobSpecs? specs = null)" +returns = "Task" +file = "Controls\\FExWindow.cs" -[[classes]] -name = "VirtualizingPanelModelBase" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" +[[methods]] +parent = "FExWindow" +name = "RunTaskAsync" +sig = "Task RunTaskAsync(Func> function, object sender = null, JobSpecs? specs = null)" +returns = "Task" +file = "Controls\\FExWindow.cs" -[[classes]] -name = "VirtualizingWrapPanel" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -base = "VirtualizingPanelBase" -summary = "A implementation of a wrap panel that supports virtualization and can be used in horizontal and vertical orientation. https://github.com/sbaeumlisberger/VirtualizingWrapPanel" -file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanel.cs" +[[methods]] +parent = "FExWindow" +name = "RunFuncAsync" +sig = "Task RunFuncAsync(Func function, object sender = null, JobSpecs? specs = null)" +returns = "Task" +file = "Controls\\FExWindow.cs" -[[classes]] -name = "VirtualizingWrapPanelModel" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -base = "VirtualizingPanelModelBase" -file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" +[[methods]] +parent = "FExWindow" +name = "FExWindow_DataContextChanged" +sig = "void FExWindow_DataContextChanged(object sender, DependencyPropertyChangedEventArgs e)" +returns = "void" +file = "Controls\\FExWindow.cs" -[[classes]] -name = "VirtualizingWrapPanelV1" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -base = "VirtualizingPanelBaseV1" -summary = "A implementation of a wrap panel that supports virtualization and can be used in horizontal and vertical orientation. In order to work properly all items must have the same size." -file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" +[[methods]] +parent = "FExWindow" +name = "OnLoaded" +sig = "void OnLoaded(object sender, RoutedEventArgs e)" +returns = "void" +file = "Controls\\FExWindow.cs" -[[classes]] -name = "VirtualizingWrapPanelWithItemExpansion" -ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" -base = "VirtualizingWrapPanelV1" -summary = "A implementation of a wrap panel that supports virtualization and can be used in horizontal and vertical orientation. In addition the panel allows to expand one specific item. In order to work properly all items must have the same size." -file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelWithItemExpansion.cs" +[[methods]] +parent = "FExWindow" +name = "PreAction" +sig = "void PreAction(object sender)" +returns = "void" +file = "Controls\\FExWindow.cs" -[[classes]] -name = "AdditionConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -file = "Converters\\AdditionConverter.cs" +[[methods]] +parent = "FExWindow" +name = "PostAction" +sig = "void PostAction(object sender, bool isSuccess)" +returns = "void" +file = "Controls\\FExWindow.cs" -[[classes]] -name = "BaseMappingConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -summary = "Base class for mapping converters." -file = "Converters\\BaseMappingConverter.cs" +[[methods]] +parent = "FExWindow" +name = "ReScale" +sig = "void ReScale()" +returns = "void" +file = "Controls\\FExWindow.cs" -[[classes]] -name = "BoolAndConverter" -ns = "FEx.WPFx.Converters" -base = "IMultiValueConverter" -file = "Converters\\BoolAndConverter.cs" +[[methods]] +parent = "FExWindow" +name = "RefreshViewModel" +sig = "void RefreshViewModel(bool refresh = false)" +returns = "void" +file = "Controls\\FExWindow.cs" -[[classes]] -name = "BoolAndToVisibilityConverter" -ns = "FEx.WPFx.Converters" -base = "IMultiValueConverter" -file = "Converters\\BoolAndToVisibilityConverter.cs" +[[methods]] +parent = "FExWindow" +name = "EnableRescaling" +sig = "void EnableRescaling(Grid mainGrid, double fixedWidth = 1920D)" +returns = "void" +file = "Controls\\FExWindow.cs" [[classes]] -name = "BoolInvertedConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -summary = "Bool invert converter." -file = "Converters\\BoolInvertedConverter.cs" +name = "IconDisplayer" +ns = "FEx.WPFx.Controls" +base = "TextBlock" +summary = "Icon displayer control." +file = "Controls\\IconDisplayer.cs" -[[classes]] -name = "BoolToVisibilityConverter" -ns = "FEx.WPFx.Converters" -base = "BaseMappingConverter" -summary = "Bool to visibility converter." -file = "Converters\\BoolToVisibilityConverter.cs" +[[properties]] +parent = "IconDisplayer" +name = "Label" +sig = "string Label { get; set; }" +returns = "string" +summary = "Gets or sets the label." +file = "Controls\\IconDisplayer.cs" -[[classes]] -name = "BoolToVisibilityInvertedConverter" -ns = "FEx.WPFx.Converters" -base = "BoolToVisibilityConverter" -summary = "Bool to Visibility Invert Converter." -file = "Converters\\BoolToVisibilityInvertedConverter.cs" +[[properties]] +parent = "IconDisplayer" +name = "Icon" +sig = "Enum Icon { get; set; }" +returns = "Enum" +summary = "Gets or sets the icon." +file = "Controls\\IconDisplayer.cs" -[[classes]] -name = "ByteToSizeConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -file = "Converters\\ByteToSizeConverter.cs" +[[properties]] +parent = "IconDisplayer" +name = "CopyText" +sig = "string CopyText { get; }" +returns = "string" +summary = "Gets the copy text." +file = "Controls\\IconDisplayer.cs" -[[classes]] -name = "CollectionIsNotNullOrEmptyToBoolConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -summary = "Represents the converter that converts the inverse of a Boolean values to and from System.Windows.Visibility enumeration values." -file = "Converters\\CollectionIsNotNullOrEmptyToBoolConverter.cs" +[[ctors]] +parent = "IconDisplayer" +sig = "IconDisplayer()" +summary = "Initializes a new instance of the class." +file = "Controls\\IconDisplayer.cs" -[[classes]] -name = "CollectionIsNotNullOrEmptyToVisibilityConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -summary = "Represents the converter that converts the inverse of a Boolean values to and from System.Windows.Visibility enumeration values." -file = "Converters\\CollectionIsNotNullOrEmptyToVisibilityConverter.cs" +[[methods]] +parent = "IconDisplayer" +name = "TextChanged" +sig = "static void TextChanged(DependencyObject sender, DependencyPropertyChangedEventArgs args)" +returns = "void" +summary = "Icons the changed handler." +file = "Controls\\IconDisplayer.cs" +static = true -[[classes]] -name = "CollectionIsNullOrEmptyToBoolConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -summary = "Represents the converter that converts the inverse of a Boolean values to and from System.Windows.Visibility enumeration values." -file = "Converters\\CollectionIsNullOrEmptyToBoolConverter.cs" +[[methods]] +parent = "IconDisplayer" +name = "UpdateText" +sig = "void UpdateText()" +returns = "void" +summary = "Updates the text." +file = "Controls\\IconDisplayer.cs" [[classes]] -name = "DivisionConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -file = "Converters\\DivisionConverter.cs" +name = "OutlinedTextBlock" +ns = "FEx.WPFx.Controls" +base = "FrameworkElement" +file = "Controls\\OutlinedTextBlock.cs" -[[classes]] -name = "EnumToStringConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -file = "Converters\\EnumToStringConverter.cs" +[[properties]] +parent = "OutlinedTextBlock" +name = "Fill" +sig = "Brush Fill { get; set; }" +returns = "Brush" +file = "Controls\\OutlinedTextBlock.cs" -[[classes]] -name = "EnumToVisibilityConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -summary = "Enum to visibility converter." -file = "Converters\\EnumToVisibilityConverter.cs" +[[properties]] +parent = "OutlinedTextBlock" +name = "FontFamily" +sig = "FontFamily FontFamily { get; set; }" +returns = "FontFamily" +file = "Controls\\OutlinedTextBlock.cs" -[[classes]] -name = "ItemsToFirstItemConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -summary = "Items to first item converter." -file = "Converters\\ItemsToFirstItemConverter.cs" +[[properties]] +parent = "OutlinedTextBlock" +name = "FontSize" +sig = "double FontSize { get; set; }" +returns = "double" +file = "Controls\\OutlinedTextBlock.cs" -[[classes]] -name = "LongToTimeStringConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -file = "Converters\\LongToTimeStringConverter.cs" +[[properties]] +parent = "OutlinedTextBlock" +name = "FontStretch" +sig = "FontStretch FontStretch { get; set; }" +returns = "FontStretch" +file = "Controls\\OutlinedTextBlock.cs" -[[classes]] -name = "MultiplicationConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -file = "Converters\\MultiplicationConverter.cs" +[[properties]] +parent = "OutlinedTextBlock" +name = "FontStyle" +sig = "FontStyle FontStyle { get; set; }" +returns = "FontStyle" +file = "Controls\\OutlinedTextBlock.cs" -[[classes]] -name = "NullableBoolInvertedConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -file = "Converters\\NullableBoolInvertedConverter.cs" +[[properties]] +parent = "OutlinedTextBlock" +name = "FontWeight" +sig = "FontWeight FontWeight { get; set; }" +returns = "FontWeight" +file = "Controls\\OutlinedTextBlock.cs" -[[classes]] -name = "NullToVisibilityConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -file = "Converters\\NullToVisibilityConverter.cs" +[[properties]] +parent = "OutlinedTextBlock" +name = "Stroke" +sig = "Brush Stroke { get; set; }" +returns = "Brush" +file = "Controls\\OutlinedTextBlock.cs" -[[classes]] -name = "NullToVisibilityInvertedConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -file = "Converters\\NullToVisibilityInvertedConverter.cs" +[[properties]] +parent = "OutlinedTextBlock" +name = "StrokeThickness" +sig = "double StrokeThickness { get; set; }" +returns = "double" +file = "Controls\\OutlinedTextBlock.cs" -[[classes]] -name = "ResizeModeToVisibilityConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -file = "Converters\\ResizeModeToVisibilityConverter.cs" +[[properties]] +parent = "OutlinedTextBlock" +name = "Text" +sig = "string Text { get; set; }" +returns = "string" +file = "Controls\\OutlinedTextBlock.cs" -[[classes]] -name = "StringToBooleanConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -summary = "String to visibility converter." -file = "Converters\\StringToBooleanConverter.cs" +[[properties]] +parent = "OutlinedTextBlock" +name = "TextAlignment" +sig = "TextAlignment TextAlignment { get; set; }" +returns = "TextAlignment" +file = "Controls\\OutlinedTextBlock.cs" -[[classes]] -name = "StringToVisibilityConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -summary = "String to visibility converter." -file = "Converters\\StringToVisibilityConverter.cs" +[[properties]] +parent = "OutlinedTextBlock" +name = "TextDecorations" +sig = "TextDecorationCollection TextDecorations { get; set; }" +returns = "TextDecorationCollection" +file = "Controls\\OutlinedTextBlock.cs" -[[classes]] -name = "SubtractionConverter" -ns = "FEx.WPFx.Converters" -base = "IValueConverter" -file = "Converters\\SubstractionConverter.cs" +[[properties]] +parent = "OutlinedTextBlock" +name = "TextTrimming" +sig = "TextTrimming TextTrimming { get; set; }" +returns = "TextTrimming" +file = "Controls\\OutlinedTextBlock.cs" -[[classes]] -name = "FolderBrowserDialogOptions" -ns = "FEx.WPFx.Dialogs" -base = "FolderBrowserDialogOptionsBase, IDisposable" -file = "Dialogs\\FolderBrowserDialogOptions.cs" +[[properties]] +parent = "OutlinedTextBlock" +name = "TextWrapping" +sig = "TextWrapping TextWrapping { get; set; }" +returns = "TextWrapping" +file = "Controls\\OutlinedTextBlock.cs" -[[classes]] -name = "OpenFileDialogOptions" -ns = "FEx.WPFx.Dialogs" -base = "OpenFileDialogOptionsBase" -file = "Dialogs\\OpenFileDialogOptions.cs" +[[ctors]] +parent = "OutlinedTextBlock" +sig = "OutlinedTextBlock()" +file = "Controls\\OutlinedTextBlock.cs" -[[classes]] -name = "SaveFileDialogOptions" -ns = "FEx.WPFx.Dialogs" -base = "SaveFileDialogOptionsBase" -file = "Dialogs\\SaveFileDialogOptions.cs" +[[methods]] +parent = "OutlinedTextBlock" +name = "OnRender" +sig = "void OnRender(DrawingContext drawingContext)" +returns = "void" +file = "Controls\\OutlinedTextBlock.cs" + +[[methods]] +parent = "OutlinedTextBlock" +name = "MeasureOverride" +sig = "Size MeasureOverride(Size availableSize)" +returns = "Size" +file = "Controls\\OutlinedTextBlock.cs" + +[[methods]] +parent = "OutlinedTextBlock" +name = "ArrangeOverride" +sig = "Size ArrangeOverride(Size finalSize)" +returns = "Size" +file = "Controls\\OutlinedTextBlock.cs" [[classes]] -name = "BitmapExtensions" -ns = "FEx.WPFx.Extensions" -file = "Extensions\\BitmapExtensions.cs" +name = "SplashScreenWindow" +ns = "FEx.WPFx.Controls" +base = "Window, INotifyPropertyChanged" +summary = "Interaction logic for MainWindow.xaml" +file = "Controls\\SplashScreenWindow.xaml.cs" + +[[properties]] +parent = "SplashScreenWindow" +name = "InitializationTask" +sig = "static Task InitializationTask { get; }" +returns = "Task" +file = "Controls\\SplashScreenWindow.xaml.cs" static = true -[[extensions]] -name = "ToBitmapImageAsync" -sig = "Task ToBitmapImageAsync(this Stream stream)" -returns = "Task" -file = "Extensions\\BitmapExtensions.cs" +[[properties]] +parent = "SplashScreenWindow" +name = "AppNameAndVersion" +sig = "string AppNameAndVersion { get; }" +returns = "string" +file = "Controls\\SplashScreenWindow.xaml.cs" -[[extensions]] -name = "ToBitmapImageAsync" -sig = "Task ToBitmapImageAsync(this Stream stream, bool forceLoad)" -returns = "Task" -file = "Extensions\\BitmapExtensions.cs" +[[properties]] +parent = "SplashScreenWindow" +name = "ApplicationLogo" +sig = "BitmapImage ApplicationLogo { get; }" +returns = "BitmapImage" +file = "Controls\\SplashScreenWindow.xaml.cs" -[[extensions]] -name = "ToBitmapImageAsync" -sig = "Task ToBitmapImageAsync(this Stream stream, bool forceLoad, bool forceMemoryStream)" -returns = "Task" -file = "Extensions\\BitmapExtensions.cs" +[[properties]] +parent = "SplashScreenWindow" +name = "Font" +sig = "FontFamily Font { get; }" +returns = "FontFamily" +file = "Controls\\SplashScreenWindow.xaml.cs" -[[extensions]] -name = "ToBitmapImage" -sig = "BitmapImage ToBitmapImage(this Stream stream)" -returns = "BitmapImage" -file = "Extensions\\BitmapExtensions.cs" +[[properties]] +parent = "SplashScreenWindow" +name = "SplashText" +sig = "string SplashText { get; }" +returns = "string" +file = "Controls\\SplashScreenWindow.xaml.cs" -[[extensions]] -name = "ToBitmapImage" -sig = "BitmapImage ToBitmapImage(this Stream stream, bool forceLoad)" -returns = "BitmapImage" -file = "Extensions\\BitmapExtensions.cs" +[[properties]] +parent = "SplashScreenWindow" +name = "ForegroundBrush" +sig = "Brush ForegroundBrush { get; }" +returns = "Brush" +file = "Controls\\SplashScreenWindow.xaml.cs" -[[extensions]] -name = "ToBitmapImage" -sig = "BitmapImage ToBitmapImage(this Stream stream, - bool forceLoad, - int decodePixelHeight, - int decodePixelWidth)" -returns = "BitmapImage" -file = "Extensions\\BitmapExtensions.cs" +[[properties]] +parent = "SplashScreenWindow" +name = "ResourceName" +sig = "string ResourceName { get; set; }" +returns = "string" +file = "Controls\\SplashScreenWindow.xaml.cs" -[[extensions]] -name = "ToBitmapSource" -sig = "BitmapSource ToBitmapSource(this Bitmap bitmap)" -returns = "BitmapSource" -summary = "To the bitmap source." -file = "Extensions\\BitmapExtensions.cs" +[[properties]] +parent = "SplashScreenWindow" +name = "DesiredTextWidth" +sig = "double DesiredTextWidth { get; set; }" +returns = "double" +file = "Controls\\SplashScreenWindow.xaml.cs" -[[extensions]] -name = "SaveToFile" -sig = "void SaveToFile(this BitmapSource image, string filePath)" +[[properties]] +parent = "SplashScreenWindow" +name = "Status" +sig = "string Status { get; }" +returns = "string" +file = "Controls\\SplashScreenWindow.xaml.cs" + +[[properties]] +parent = "SplashScreenWindow" +name = "DesiredWidth" +sig = "double DesiredWidth { get; set; }" +returns = "double" +file = "Controls\\SplashScreenWindow.xaml.cs" + +[[properties]] +parent = "SplashScreenWindow" +name = "DesiredHeight" +sig = "double DesiredHeight { get; set; }" +returns = "double" +file = "Controls\\SplashScreenWindow.xaml.cs" + +[[properties]] +parent = "SplashScreenWindow" +name = "TotalDesiredWidth" +sig = "double TotalDesiredWidth { get; set; }" +returns = "double" +file = "Controls\\SplashScreenWindow.xaml.cs" + +[[properties]] +parent = "SplashScreenWindow" +name = "TotalDesiredHeight" +sig = "double TotalDesiredHeight { get; set; }" +returns = "double" +file = "Controls\\SplashScreenWindow.xaml.cs" + +[[properties]] +parent = "SplashScreenWindow" +name = "ResourceAssembly" +sig = "Assembly ResourceAssembly { get; }" +returns = "Assembly" +file = "Controls\\SplashScreenWindow.xaml.cs" + +[[properties]] +parent = "SplashScreenWindow" +name = "StatusHub" +sig = "IStatusHub StatusHub { get; set; }" +returns = "IStatusHub" +file = "Controls\\SplashScreenWindow.xaml.cs" + +[[properties]] +parent = "SplashScreenWindow" +name = "MainHubKey" +sig = "Guid? MainHubKey { get; }" +returns = "Guid?" +file = "Controls\\SplashScreenWindow.xaml.cs" + +[[ctors]] +parent = "SplashScreenWindow" +sig = "SplashScreenWindow(IAppInfoProvider appInfoProvider, IAsyncHelper asyncHelper, IStatusService statusService, IAppConfig appConfig)" +file = "Controls\\SplashScreenWindow.xaml.cs" + +[[methods]] +parent = "SplashScreenWindow" +name = "OnPropertyChanged" +sig = "void OnPropertyChanged([CallerMemberName] string propertyName = null)" returns = "void" -summary = "Saves to file." -file = "Extensions\\BitmapExtensions.cs" +file = "Controls\\SplashScreenWindow.xaml.cs" -[[extensions]] -name = "ToBitmapImageAsync" -sig = "Task ToBitmapImageAsync(this byte[] array)" -returns = "Task" -summary = "Saves to file." -file = "Extensions\\BitmapExtensions.cs" +[[methods]] +parent = "SplashScreenWindow" +name = "SetProperty" +sig = "bool SetProperty(ref T backingField, T newValue, Action onPropertyChanged = null, [CallerMemberName] string propertyName = null)" +returns = "bool" +file = "Controls\\SplashScreenWindow.xaml.cs" -[[extensions]] -name = "ToBitmapImageAsync" -sig = "Task ToBitmapImageAsync(this Image image)" -returns = "Task" -summary = "Takes a bitmap and converts it to an image that can be handled by WPF ImageBrush" -file = "Extensions\\BitmapExtensions.cs" +[[classes]] +name = "TreeViewBuilder" +ns = "FEx.WPFx.Controls" +base = "TreeViewBuilderBase" +file = "Controls\\TreeViewBuilder.cs" -[[extensions]] -name = "ToBitmapImageAsync" -sig = "Task ToBitmapImageAsync(this Image image, ImageFormat imageFormat)" -returns = "Task" -summary = "Takes a bitmap and converts it to an image that can be handled by WPF ImageBrush" -file = "Extensions\\BitmapExtensions.cs" +[[ctors]] +parent = "TreeViewBuilder" +sig = "TreeViewBuilder(IFExDispatcher dispatcher, FileSystemIconsProvider fileSystemIconsProvider)" +file = "Controls\\TreeViewBuilder.cs" + +[[methods]] +parent = "TreeViewBuilder" +name = "GetTreeViewItemAsync" +sig = "Task GetTreeViewItemAsync(FExTreeViewNode nodeStub)" +returns = "Task" +summary = "Gets the TreeView item." +file = "Controls\\TreeViewBuilder.cs" [[classes]] -name = "ColorExtensions" -ns = "FEx.WPFx.Extensions" -file = "Extensions\\ColorExtensions.cs" -static = true +name = "TreeViewBuilderBase" +ns = "FEx.WPFx.Controls" +base = "ITreeViewBuilder" +file = "Controls\\TreeViewBuilderBase.cs" -[[extensions]] -name = "ToMediaColor" -sig = "MColor ToMediaColor(this DColor color)" -returns = "MColor" -file = "Extensions\\ColorExtensions.cs" +[[properties]] +parent = "TreeViewBuilderBase" +name = "TreeNodes" +sig = "ConcurrentDictionary TreeNodes { get; }" +returns = "ConcurrentDictionary" +file = "Controls\\TreeViewBuilderBase.cs" + +[[ctors]] +parent = "TreeViewBuilderBase" +sig = "TreeViewBuilderBase(FileSystemIconsProvider fileSystemIconsProvider, IFExDispatcher dispatcher)" +file = "Controls\\TreeViewBuilderBase.cs" + +[[methods]] +parent = "TreeViewBuilderBase" +name = "CreateNewNode" +sig = "void CreateNewNode(FExTreeViewNode node)" +returns = "void" +file = "Controls\\TreeViewBuilderBase.cs" + +[[methods]] +parent = "TreeViewBuilderBase" +name = "AddChildNode" +sig = "void AddChildNode(string rootNodeName, List nodePath, string name, bool unique, string iconPath, bool isIconAttachedToFile, bool isExpanded)" +returns = "void" +file = "Controls\\TreeViewBuilderBase.cs" + +[[methods]] +parent = "TreeViewBuilderBase" +name = "AddChildNodes" +sig = "void AddChildNodes(string rootNodeName, IEnumerable childNodes, bool unique)" +returns = "void" +file = "Controls\\TreeViewBuilderBase.cs" + +[[methods]] +parent = "TreeViewBuilderBase" +name = "CreateNewNode" +sig = "void CreateNewNode(string nodePath)" +returns = "void" +file = "Controls\\TreeViewBuilderBase.cs" + +[[methods]] +parent = "TreeViewBuilderBase" +name = "AddChildNode" +sig = "void AddChildNode(string rootNodeName, string nodePath, string name, char pathSeparator, bool unique, string iconPath, bool isExpanded)" +returns = "void" +file = "Controls\\TreeViewBuilderBase.cs" + +[[methods]] +parent = "TreeViewBuilderBase" +name = "GetTreeViewItemAsync" +sig = "Task GetTreeViewItemAsync(FExTreeViewNode nodeStub)" +returns = "Task" +file = "Controls\\TreeViewBuilderBase.cs" + +[[methods]] +parent = "TreeViewBuilderBase" +name = "GrowTreeAsync" +sig = "Task GrowTreeAsync(ItemsControl tree, IReadOnlyList curr, int i)" +returns = "Task" +file = "Controls\\TreeViewBuilderBase.cs" + +[[methods]] +parent = "TreeViewBuilderBase" +name = "GrowTreeAsync" +sig = "Task GrowTreeAsync(ItemsControl tree, TItem newNode, int[] location, int i)" +returns = "Task" +summary = "Grows the tree." +file = "Controls\\TreeViewBuilderBase.cs" + +[[methods]] +parent = "TreeViewBuilderBase" +name = "GrowTreeAsync" +sig = "Task GrowTreeAsync(TItem tree, FExTreeViewNode nodeStub, int locationIndex, bool setDirectoriesIcons)" +returns = "Task" +summary = "Grows the tree." +file = "Controls\\TreeViewBuilderBase.cs" + +[[methods]] +parent = "TreeViewBuilderBase" +name = "GrowTreeAsync" +sig = "Task GrowTreeAsync(TItem tree, FExTreeViewNode nodeStub, IList headers, int locationIndex, bool setDirectoriesIcons)" +returns = "Task" +file = "Controls\\TreeViewBuilderBase.cs" + +[[methods]] +parent = "TreeViewBuilderBase" +name = "GetTreeNodeAsync" +sig = "Task GetTreeNodeAsync(string rootNodeName, bool setDirectoriesIcons)" +returns = "Task" +file = "Controls\\TreeViewBuilderBase.cs" + +[[methods]] +parent = "TreeViewBuilderBase" +name = "GetBitmapSourceAsync" +sig = "Task GetBitmapSourceAsync(FExTreeViewNode nodeStub)" +returns = "Task" +file = "Controls\\TreeViewBuilderBase.cs" + +[[methods]] +parent = "TreeViewBuilderBase" +name = "GetRootNodeStub" +sig = "FExTreeViewNode GetRootNodeStub(string rootNodeName)" +returns = "FExTreeViewNode" +file = "Controls\\TreeViewBuilderBase.cs" + +[[classes]] +name = "VerticalTextBlock" +ns = "FEx.WPFx.Controls" +base = "TextBlock" +file = "Controls\\VerticalTextBlock.cs" + +[[properties]] +parent = "VerticalTextBlock" +name = "Text" +sig = "string Text { get; set; }" +returns = "string" +file = "Controls\\VerticalTextBlock.cs" + +[[classes]] +name = "ZoomBorder" +ns = "FEx.WPFx.Controls" +base = "Border, INotifyPropertyChanged" +file = "Controls\\ZoomBorder.cs" + +[[properties]] +parent = "ZoomBorder" +name = "Child" +sig = "UIElement Child { get; set; }" +returns = "UIElement" +file = "Controls\\ZoomBorder.cs" + +[[properties]] +parent = "ZoomBorder" +name = "MaxScale" +sig = "double MaxScale { get; }" +returns = "double" +file = "Controls\\ZoomBorder.cs" + +[[properties]] +parent = "ZoomBorder" +name = "MaxScaleToZoomIn" +sig = "double MaxScaleToZoomIn { get; }" +returns = "double" +file = "Controls\\ZoomBorder.cs" + +[[properties]] +parent = "ZoomBorder" +name = "DefaultScale" +sig = "double DefaultScale { get; }" +returns = "double" +file = "Controls\\ZoomBorder.cs" + +[[properties]] +parent = "ZoomBorder" +name = "DefaultZoom" +sig = "double DefaultZoom { get; }" +returns = "double" +file = "Controls\\ZoomBorder.cs" + +[[properties]] +parent = "ZoomBorder" +name = "ScaleChanged" +sig = "Action ScaleChanged { get; }" +returns = "Action" +file = "Controls\\ZoomBorder.cs" + +[[properties]] +parent = "ZoomBorder" +name = "Subscriptions" +sig = "ConcurrentDictionary Subscriptions { get; }" +returns = "ConcurrentDictionary" +file = "Controls\\ZoomBorder.cs" + +[[properties]] +parent = "ZoomBorder" +name = "Scale" +sig = "double Scale { get; set; }" +returns = "double" +file = "Controls\\ZoomBorder.cs" + +[[properties]] +parent = "ZoomBorder" +name = "IsAutoFitEnabled" +sig = "bool IsAutoFitEnabled { get; set; }" +returns = "bool" +file = "Controls\\ZoomBorder.cs" + +[[properties]] +parent = "ZoomBorder" +name = "ParentSize" +sig = "Size ParentSize { get; set; }" +returns = "Size" +file = "Controls\\ZoomBorder.cs" + +[[properties]] +parent = "ZoomBorder" +name = "AnimationSXTcs" +sig = "TaskCompletionSource AnimationSXTcs { get; set; }" +returns = "TaskCompletionSource" +file = "Controls\\ZoomBorder.cs" + +[[properties]] +parent = "ZoomBorder" +name = "AnimationSYTcs" +sig = "TaskCompletionSource AnimationSYTcs { get; set; }" +returns = "TaskCompletionSource" +file = "Controls\\ZoomBorder.cs" + +[[properties]] +parent = "ZoomBorder" +name = "AnimationAXTcs" +sig = "TaskCompletionSource AnimationAXTcs { get; set; }" +returns = "TaskCompletionSource" +file = "Controls\\ZoomBorder.cs" + +[[properties]] +parent = "ZoomBorder" +name = "AnimationAYTcs" +sig = "TaskCompletionSource AnimationAYTcs { get; set; }" +returns = "TaskCompletionSource" +file = "Controls\\ZoomBorder.cs" + +[[ctors]] +parent = "ZoomBorder" +sig = "ZoomBorder()" +file = "Controls\\ZoomBorder.cs" + +[[methods]] +parent = "ZoomBorder" +name = "SetOnScaleChanged" +sig = "void SetOnScaleChanged(Action handler)" +returns = "void" +file = "Controls\\ZoomBorder.cs" + +[[methods]] +parent = "ZoomBorder" +name = "Reset" +sig = "void Reset()" +returns = "void" +file = "Controls\\ZoomBorder.cs" + +[[methods]] +parent = "ZoomBorder" +name = "Zoom" +sig = "void Zoom(double zoom, Point position, bool animate)" +returns = "void" +file = "Controls\\ZoomBorder.cs" + +[[methods]] +parent = "ZoomBorder" +name = "WaitForAnimationToCompleteAsync" +sig = "Task WaitForAnimationToCompleteAsync()" +returns = "Task" +file = "Controls\\ZoomBorder.cs" + +[[methods]] +parent = "ZoomBorder" +name = "OnAutoFitChanged" +sig = "void OnAutoFitChanged(bool autoFit)" +returns = "void" +file = "Controls\\ZoomBorder.cs" + +[[methods]] +parent = "ZoomBorder" +name = "OnPropertyChanged" +sig = "void OnPropertyChanged([CallerMemberName] string propertyName = null)" +returns = "void" +file = "Controls\\ZoomBorder.cs" + +[[methods]] +parent = "ZoomBorder" +name = "OnRenderSizeChanged" +sig = "void OnRenderSizeChanged(SizeChangedInfo sizeInfo)" +returns = "void" +file = "Controls\\ZoomBorder.cs" + +[[classes]] +name = "AdditionConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +file = "Converters\\AdditionConverter.cs" + +[[methods]] +parent = "AdditionConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\AdditionConverter.cs" + +[[methods]] +parent = "AdditionConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\AdditionConverter.cs" + +[[classes]] +name = "BaseMappingConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +summary = "Base class for mapping converters." +file = "Converters\\BaseMappingConverter.cs" + +[[properties]] +parent = "BaseMappingConverter" +name = "DefaultValue" +sig = "TOut DefaultValue { get; }" +returns = "TOut" +summary = "Gets the default value." +file = "Converters\\BaseMappingConverter.cs" + +[[methods]] +parent = "BaseMappingConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a value." +file = "Converters\\BaseMappingConverter.cs" + +[[methods]] +parent = "BaseMappingConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a value." +file = "Converters\\BaseMappingConverter.cs" + +[[methods]] +parent = "BaseMappingConverter" +name = "InitializeMappings" +sig = "Dictionary InitializeMappings()" +returns = "Dictionary" +summary = "Initializes the mappings." +file = "Converters\\BaseMappingConverter.cs" + +[[methods]] +parent = "BaseMappingConverter" +name = "InitializeParametrizedMappings" +sig = "Dictionary> InitializeParametrizedMappings()" +returns = "Dictionary>" +summary = "Initializes the parametrized mappings." +file = "Converters\\BaseMappingConverter.cs" + +[[classes]] +name = "BoolAndConverter" +ns = "FEx.WPFx.Converters" +base = "IMultiValueConverter" +file = "Converters\\BoolAndConverter.cs" + +[[methods]] +parent = "BoolAndConverter" +name = "Convert" +sig = "object Convert(object[] values, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\BoolAndConverter.cs" + +[[methods]] +parent = "BoolAndConverter" +name = "ConvertBack" +sig = "object[] ConvertBack(object value, Type[] targetTypes, object parameter, CultureInfo culture)" +returns = "object[]" +file = "Converters\\BoolAndConverter.cs" + +[[classes]] +name = "BoolAndToVisibilityConverter" +ns = "FEx.WPFx.Converters" +base = "IMultiValueConverter" +file = "Converters\\BoolAndToVisibilityConverter.cs" + +[[methods]] +parent = "BoolAndToVisibilityConverter" +name = "Convert" +sig = "object Convert(object[] values, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\BoolAndToVisibilityConverter.cs" + +[[methods]] +parent = "BoolAndToVisibilityConverter" +name = "ConvertBack" +sig = "object[] ConvertBack(object value, Type[] targetTypes, object parameter, CultureInfo culture)" +returns = "object[]" +file = "Converters\\BoolAndToVisibilityConverter.cs" + +[[classes]] +name = "BoolInvertedConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +summary = "Bool invert converter." +file = "Converters\\BoolInvertedConverter.cs" + +[[methods]] +parent = "BoolInvertedConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a value." +file = "Converters\\BoolInvertedConverter.cs" + +[[methods]] +parent = "BoolInvertedConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a value." +file = "Converters\\BoolInvertedConverter.cs" + +[[classes]] +name = "BoolToVisibilityConverter" +ns = "FEx.WPFx.Converters" +base = "BaseMappingConverter" +summary = "Bool to visibility converter." +file = "Converters\\BoolToVisibilityConverter.cs" + +[[properties]] +parent = "BoolToVisibilityConverter" +name = "DefaultValue" +sig = "Visibility DefaultValue { get; }" +returns = "Visibility" +summary = "Gets the default value." +file = "Converters\\BoolToVisibilityConverter.cs" + +[[methods]] +parent = "BoolToVisibilityConverter" +name = "InitializeMappings" +sig = "Dictionary InitializeMappings()" +returns = "Dictionary" +summary = "Initializes the mappings." +file = "Converters\\BoolToVisibilityConverter.cs" + +[[classes]] +name = "BoolToVisibilityInvertedConverter" +ns = "FEx.WPFx.Converters" +base = "BoolToVisibilityConverter" +summary = "Bool to Visibility Invert Converter." +file = "Converters\\BoolToVisibilityInvertedConverter.cs" + +[[methods]] +parent = "BoolToVisibilityInvertedConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a value." +file = "Converters\\BoolToVisibilityInvertedConverter.cs" + +[[classes]] +name = "ByteToSizeConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +file = "Converters\\ByteToSizeConverter.cs" + +[[methods]] +parent = "ByteToSizeConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\ByteToSizeConverter.cs" + +[[methods]] +parent = "ByteToSizeConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\ByteToSizeConverter.cs" + +[[classes]] +name = "CollectionIsNotNullOrEmptyToBoolConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +summary = "Represents the converter that converts the inverse of a Boolean values to and from System.Windows.Visibility enumeration values." +file = "Converters\\CollectionIsNotNullOrEmptyToBoolConverter.cs" + +[[methods]] +parent = "CollectionIsNotNullOrEmptyToBoolConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a Boolean value to a System.Windows.Visibility enumeration value." +file = "Converters\\CollectionIsNotNullOrEmptyToBoolConverter.cs" + +[[methods]] +parent = "CollectionIsNotNullOrEmptyToBoolConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a System.Windows.Visibility enumeration value to a Boolean value." +file = "Converters\\CollectionIsNotNullOrEmptyToBoolConverter.cs" + +[[classes]] +name = "CollectionIsNotNullOrEmptyToVisibilityConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +summary = "Represents the converter that converts the inverse of a Boolean values to and from System.Windows.Visibility enumeration values." +file = "Converters\\CollectionIsNotNullOrEmptyToVisibilityConverter.cs" + +[[methods]] +parent = "CollectionIsNotNullOrEmptyToVisibilityConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a Boolean value to a System.Windows.Visibility enumeration value." +file = "Converters\\CollectionIsNotNullOrEmptyToVisibilityConverter.cs" + +[[methods]] +parent = "CollectionIsNotNullOrEmptyToVisibilityConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a System.Windows.Visibility enumeration value to a Boolean value." +file = "Converters\\CollectionIsNotNullOrEmptyToVisibilityConverter.cs" + +[[classes]] +name = "CollectionIsNullOrEmptyToBoolConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +summary = "Represents the converter that converts the inverse of a Boolean values to and from System.Windows.Visibility enumeration values." +file = "Converters\\CollectionIsNullOrEmptyToBoolConverter.cs" + +[[methods]] +parent = "CollectionIsNullOrEmptyToBoolConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a Boolean value to a System.Windows.Visibility enumeration value." +file = "Converters\\CollectionIsNullOrEmptyToBoolConverter.cs" + +[[methods]] +parent = "CollectionIsNullOrEmptyToBoolConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a System.Windows.Visibility enumeration value to a Boolean value." +file = "Converters\\CollectionIsNullOrEmptyToBoolConverter.cs" + +[[classes]] +name = "DivisionConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +file = "Converters\\DivisionConverter.cs" + +[[methods]] +parent = "DivisionConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\DivisionConverter.cs" + +[[methods]] +parent = "DivisionConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\DivisionConverter.cs" + +[[classes]] +name = "EnumToStringConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +file = "Converters\\EnumToStringConverter.cs" + +[[methods]] +parent = "EnumToStringConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\EnumToStringConverter.cs" + +[[methods]] +parent = "EnumToStringConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\EnumToStringConverter.cs" + +[[classes]] +name = "EnumToVisibilityConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +summary = "Enum to visibility converter." +file = "Converters\\EnumToVisibilityConverter.cs" + +[[methods]] +parent = "EnumToVisibilityConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a value." +file = "Converters\\EnumToVisibilityConverter.cs" + +[[methods]] +parent = "EnumToVisibilityConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Not implemented" +file = "Converters\\EnumToVisibilityConverter.cs" + +[[classes]] +name = "ItemsToFirstItemConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +summary = "Items to first item converter." +file = "Converters\\ItemsToFirstItemConverter.cs" + +[[methods]] +parent = "ItemsToFirstItemConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a value." +file = "Converters\\ItemsToFirstItemConverter.cs" + +[[methods]] +parent = "ItemsToFirstItemConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a value." +file = "Converters\\ItemsToFirstItemConverter.cs" + +[[classes]] +name = "LongToTimeStringConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +file = "Converters\\LongToTimeStringConverter.cs" + +[[methods]] +parent = "LongToTimeStringConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\LongToTimeStringConverter.cs" + +[[methods]] +parent = "LongToTimeStringConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\LongToTimeStringConverter.cs" + +[[classes]] +name = "MultiplicationConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +file = "Converters\\MultiplicationConverter.cs" + +[[methods]] +parent = "MultiplicationConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\MultiplicationConverter.cs" + +[[methods]] +parent = "MultiplicationConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\MultiplicationConverter.cs" + +[[classes]] +name = "NullableBoolInvertedConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +file = "Converters\\NullableBoolInvertedConverter.cs" + +[[methods]] +parent = "NullableBoolInvertedConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\NullableBoolInvertedConverter.cs" + +[[methods]] +parent = "NullableBoolInvertedConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\NullableBoolInvertedConverter.cs" + +[[classes]] +name = "NullToVisibilityConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +file = "Converters\\NullToVisibilityConverter.cs" + +[[methods]] +parent = "NullToVisibilityConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\NullToVisibilityConverter.cs" + +[[methods]] +parent = "NullToVisibilityConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\NullToVisibilityConverter.cs" + +[[classes]] +name = "NullToVisibilityInvertedConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +file = "Converters\\NullToVisibilityInvertedConverter.cs" + +[[methods]] +parent = "NullToVisibilityInvertedConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\NullToVisibilityInvertedConverter.cs" + +[[methods]] +parent = "NullToVisibilityInvertedConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\NullToVisibilityInvertedConverter.cs" + +[[classes]] +name = "ResizeModeToVisibilityConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +file = "Converters\\ResizeModeToVisibilityConverter.cs" + +[[methods]] +parent = "ResizeModeToVisibilityConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a value." +file = "Converters\\ResizeModeToVisibilityConverter.cs" + +[[methods]] +parent = "ResizeModeToVisibilityConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a value." +file = "Converters\\ResizeModeToVisibilityConverter.cs" + +[[classes]] +name = "StringToBooleanConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +summary = "String to visibility converter." +file = "Converters\\StringToBooleanConverter.cs" + +[[methods]] +parent = "StringToBooleanConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a value." +file = "Converters\\StringToBooleanConverter.cs" + +[[methods]] +parent = "StringToBooleanConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a value." +file = "Converters\\StringToBooleanConverter.cs" + +[[classes]] +name = "StringToVisibilityConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +summary = "String to visibility converter." +file = "Converters\\StringToVisibilityConverter.cs" + +[[methods]] +parent = "StringToVisibilityConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a value." +file = "Converters\\StringToVisibilityConverter.cs" + +[[methods]] +parent = "StringToVisibilityConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +summary = "Converts a value." +file = "Converters\\StringToVisibilityConverter.cs" + +[[classes]] +name = "SubtractionConverter" +ns = "FEx.WPFx.Converters" +base = "IValueConverter" +file = "Converters\\SubstractionConverter.cs" + +[[methods]] +parent = "SubtractionConverter" +name = "Convert" +sig = "object Convert(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\SubstractionConverter.cs" + +[[methods]] +parent = "SubtractionConverter" +name = "ConvertBack" +sig = "object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)" +returns = "object" +file = "Converters\\SubstractionConverter.cs" + +[[classes]] +name = "FolderBrowserDialogOptions" +ns = "FEx.WPFx.Dialogs" +base = "FolderBrowserDialogOptionsBase, IDisposable" +file = "Dialogs\\FolderBrowserDialogOptions.cs" + +[[methods]] +parent = "FolderBrowserDialogOptions" +name = "ShowDialogOk" +sig = "bool ShowDialogOk(Window owner = null, IProgressAggregator viewModel = null)" +returns = "bool" +summary = "Shows the dialog." +file = "Dialogs\\FolderBrowserDialogOptions.cs" + +[[methods]] +parent = "FolderBrowserDialogOptions" +name = "ShowDialog" +sig = "DialogResult ShowDialog(Window owner = null, IProgressAggregator viewModel = null)" +returns = "DialogResult" +summary = "Shows the dialog." +file = "Dialogs\\FolderBrowserDialogOptions.cs" + +[[methods]] +parent = "FolderBrowserDialogOptions" +name = "MapToDialog" +sig = "FolderBrowserDialog MapToDialog()" +returns = "FolderBrowserDialog" +file = "Dialogs\\FolderBrowserDialogOptions.cs" + +[[methods]] +parent = "FolderBrowserDialogOptions" +name = "MapFromDialog" +sig = "void MapFromDialog(FolderBrowserDialog dialog)" +returns = "void" +file = "Dialogs\\FolderBrowserDialogOptions.cs" + +[[methods]] +parent = "FolderBrowserDialogOptions" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Dialogs\\FolderBrowserDialogOptions.cs" + +[[classes]] +name = "OpenFileDialogOptions" +ns = "FEx.WPFx.Dialogs" +base = "OpenFileDialogOptionsBase" +file = "Dialogs\\OpenFileDialogOptions.cs" + +[[methods]] +parent = "OpenFileDialogOptions" +name = "ShowDialog" +sig = "bool ShowDialog(Window owner = null, IProgressAggregator viewModel = null)" +returns = "bool" +summary = "Shows the dialog." +file = "Dialogs\\OpenFileDialogOptions.cs" + +[[methods]] +parent = "OpenFileDialogOptions" +name = "MapToDialog" +sig = "OpenFileDialog MapToDialog()" +returns = "OpenFileDialog" +file = "Dialogs\\OpenFileDialogOptions.cs" + +[[methods]] +parent = "OpenFileDialogOptions" +name = "MapFromDialog" +sig = "void MapFromDialog(OpenFileDialog dialog)" +returns = "void" +file = "Dialogs\\OpenFileDialogOptions.cs" + +[[classes]] +name = "SaveFileDialogOptions" +ns = "FEx.WPFx.Dialogs" +base = "SaveFileDialogOptionsBase" +file = "Dialogs\\SaveFileDialogOptions.cs" + +[[methods]] +parent = "SaveFileDialogOptions" +name = "ShowDialog" +sig = "bool ShowDialog(Window owner = null, IProgressAggregator viewModel = null)" +returns = "bool" +summary = "Shows the dialog." +file = "Dialogs\\SaveFileDialogOptions.cs" + +[[methods]] +parent = "SaveFileDialogOptions" +name = "MapToDialog" +sig = "SaveFileDialog MapToDialog()" +returns = "SaveFileDialog" +file = "Dialogs\\SaveFileDialogOptions.cs" + +[[methods]] +parent = "SaveFileDialogOptions" +name = "MapFromDialog" +sig = "void MapFromDialog(SaveFileDialog dialog)" +returns = "void" +file = "Dialogs\\SaveFileDialogOptions.cs" + +[[classes]] +name = "BitmapExtensions" +ns = "FEx.WPFx.Extensions" +file = "Extensions\\BitmapExtensions.cs" +static = true + +[[extensions]] +name = "ToBitmapImageAsync" +returns = "Task" +sig = "Task ToBitmapImageAsync(this Stream stream)" +file = "Extensions\\BitmapExtensions.cs" + +[[extensions]] +name = "ToBitmapImageAsync" +returns = "Task" +sig = "Task ToBitmapImageAsync(this Stream stream, bool forceLoad)" +file = "Extensions\\BitmapExtensions.cs" + +[[extensions]] +name = "ToBitmapImageAsync" +returns = "Task" +sig = "Task ToBitmapImageAsync(this Stream stream, bool forceLoad, bool forceMemoryStream)" +file = "Extensions\\BitmapExtensions.cs" + +[[extensions]] +name = "ToBitmapImageAsync" +returns = "Task" +sig = "Task ToBitmapImageAsync(this Stream stream, bool forceLoad, bool forceMemoryStream, int decodePixelHeight, int decodePixelWidth)" +file = "Extensions\\BitmapExtensions.cs" + +[[extensions]] +name = "ToBitmapImage" +returns = "BitmapImage" +sig = "BitmapImage ToBitmapImage(this Stream stream)" +file = "Extensions\\BitmapExtensions.cs" + +[[extensions]] +name = "ToBitmapImage" +returns = "BitmapImage" +sig = "BitmapImage ToBitmapImage(this Stream stream, bool forceLoad)" +file = "Extensions\\BitmapExtensions.cs" + +[[extensions]] +name = "ToBitmapImage" +returns = "BitmapImage" +sig = "BitmapImage ToBitmapImage(this Stream stream, bool forceLoad, int decodePixelHeight, int decodePixelWidth)" +file = "Extensions\\BitmapExtensions.cs" + +[[extensions]] +name = "ToBitmapSource" +returns = "BitmapSource" +sig = "BitmapSource ToBitmapSource(this Bitmap bitmap)" +summary = "To the bitmap source." +file = "Extensions\\BitmapExtensions.cs" + +[[extensions]] +name = "SaveToFile" +returns = "void" +sig = "void SaveToFile(this BitmapSource image, string filePath)" +summary = "Saves to file." +file = "Extensions\\BitmapExtensions.cs" + +[[extensions]] +name = "ToBitmapImageAsync" +returns = "Task" +sig = "Task ToBitmapImageAsync(this byte[] array)" +file = "Extensions\\BitmapExtensions.cs" + +[[extensions]] +name = "ToBitmapImageAsync" +returns = "Task" +sig = "Task ToBitmapImageAsync(this byte[] array, bool forceLoad)" +file = "Extensions\\BitmapExtensions.cs" + +[[extensions]] +name = "ToBitmapImageAsync" +returns = "Task" +sig = "Task ToBitmapImageAsync(this Image image)" +summary = "Takes a bitmap and converts it to an image that can be handled by WPF ImageBrush" +file = "Extensions\\BitmapExtensions.cs" + +[[extensions]] +name = "ToBitmapImageAsync" +returns = "Task" +sig = "Task ToBitmapImageAsync(this Image image, ImageFormat imageFormat)" +file = "Extensions\\BitmapExtensions.cs" + +[[extensions]] +name = "ToBitmapImageAsync" +returns = "Task" +sig = "Task ToBitmapImageAsync(this Image image, ImageFormat imageFormat, bool forceLoad)" +file = "Extensions\\BitmapExtensions.cs" + +[[methods]] +parent = "BitmapExtensions" +name = "GetSize" +sig = "static WidthAndHeight GetSize(Stream originalStream)" +returns = "WidthAndHeight" +file = "Extensions\\BitmapExtensions.cs" +static = true + +[[classes]] +name = "ColorExtensions" +ns = "FEx.WPFx.Extensions" +file = "Extensions\\ColorExtensions.cs" +static = true + +[[methods]] +parent = "ColorExtensions" +name = "FromArgbString" +sig = "static MColor FromArgbString(string colorcode)" +returns = "MColor" +file = "Extensions\\ColorExtensions.cs" +static = true + +[[methods]] +parent = "ColorExtensions" +name = "FromRgbString" +sig = "static MColor FromRgbString(string colorcode)" +returns = "MColor" +file = "Extensions\\ColorExtensions.cs" +static = true + +[[extensions]] +name = "ToMediaColor" +returns = "MColor" +sig = "MColor ToMediaColor(this DColor color)" +file = "Extensions\\ColorExtensions.cs" + +[[classes]] +name = "DependencyObjectExtensions" +ns = "FEx.WPFx.Extensions" +file = "Extensions\\DependencyObjectExtensions.cs" +static = true + +[[extensions]] +name = "GetViewModel" +returns = "TViewModel" +sig = "TViewModel GetViewModel(this FrameworkElement view)" +file = "Extensions\\DependencyObjectExtensions.cs" + +[[extensions]] +name = "InvokeOnDispatcherContext" +returns = "void" +sig = "void InvokeOnDispatcherContext(this DependencyObject sender, Action action, DispatcherPriority priority = DispatcherPriority.Send)" +file = "Extensions\\DependencyObjectExtensions.cs" + +[[extensions]] +name = "InvokeOnDispatcherContextAsync" +returns = "Task" +sig = "Task InvokeOnDispatcherContextAsync(this DependencyObject sender, Action action, DispatcherPriority priority = DispatcherPriority.Send)" +file = "Extensions\\DependencyObjectExtensions.cs" + +[[extensions]] +name = "InvokeOnDispatcherContextAsync" +returns = "Task" +sig = "Task InvokeOnDispatcherContextAsync(this DependencyObject sender, Func action, DispatcherPriority priority = DispatcherPriority.Send)" +file = "Extensions\\DependencyObjectExtensions.cs" + +[[extensions]] +name = "InvokeOnDispatcherContext" +returns = "T" +sig = "T InvokeOnDispatcherContext(this DependencyObject sender, Func action, DispatcherPriority priority = DispatcherPriority.Send)" +file = "Extensions\\DependencyObjectExtensions.cs" + +[[extensions]] +name = "DoUpdateSource" +returns = "void" +sig = "void DoUpdateSource(this DependencyProperty property, object source)" +file = "Extensions\\DependencyObjectExtensions.cs" + +[[classes]] +name = "DependencyPropertyExtensions" +ns = "FEx.WPFx.Extensions" +file = "Extensions\\DependencyPropertyExtensions.cs" +static = true + +[[methods]] +parent = "DependencyPropertyExtensions" +name = "CreateTwoWayDependencyProperty" +sig = "static DependencyProperty CreateTwoWayDependencyProperty( Expression> propertyExpression, TProperty defaultValue = default, Action<(TView view, TProperty oldValue, TProperty newValue)> propertyChanged = null, Func<(TView view, TProperty currentValue), TProperty> coerceValue = null, Func validateValue = null) where TView : DependencyObject" +returns = "DependencyProperty" +file = "Extensions\\DependencyPropertyExtensions.cs" +static = true + +[[methods]] +parent = "DependencyPropertyExtensions" +name = "CreateTwoWayDependencyProperty" +sig = "static DependencyProperty CreateTwoWayDependencyProperty(string propertyName, TProperty defaultValue = default, Action<(TView view, TProperty oldValue, TProperty newValue)> propertyChanged = null, Func<(TView view, TProperty currentValue), TProperty> coerceValue = null, Func validateValue = null) where TView : DependencyObject" +returns = "DependencyProperty" +file = "Extensions\\DependencyPropertyExtensions.cs" +static = true + +[[methods]] +parent = "DependencyPropertyExtensions" +name = "CreateDependencyProperty" +sig = "static DependencyProperty CreateDependencyProperty( Expression> propertyExpression, TProperty defaultValue = default, FrameworkPropertyMetadataOptions flags = FrameworkPropertyMetadataOptions.None, Action<(TView view, TProperty oldValue, TProperty newValue)> propertyChanged = null, Func<(TView view, TProperty currentValue), TProperty> coerceValue = null, Func validateValue = null) where TView : DependencyObject" +returns = "DependencyProperty" +file = "Extensions\\DependencyPropertyExtensions.cs" +static = true + +[[methods]] +parent = "DependencyPropertyExtensions" +name = "CreateDependencyProperty" +sig = "static DependencyProperty CreateDependencyProperty(string propertyName, TProperty defaultValue = default, FrameworkPropertyMetadataOptions flags = FrameworkPropertyMetadataOptions.None, Action<(TView view, TProperty oldValue, TProperty newValue)> propertyChanged = null, Func<(TView view, TProperty currentValue), TProperty> coerceValue = null, Func validateValue = null) where TView : DependencyObject" +returns = "DependencyProperty" +file = "Extensions\\DependencyPropertyExtensions.cs" +static = true + +[[methods]] +parent = "DependencyPropertyExtensions" +name = "CreateCollectionDependencyProperty" +sig = "static DependencyProperty CreateCollectionDependencyProperty(string propertyName, TProperty defaultValue = default, FrameworkPropertyMetadataOptions flags = FrameworkPropertyMetadataOptions.None, Action<(TView view, TProperty oldValue, TProperty newValue)> propertyChanged = null, Action<(TView view, IList oldItems, IList newItems)> collectionChanged = null, Func<(TView view, TProperty currentValue), TProperty> coerceValue = null, Func validateValue = null) where TView : DependencyObject where TProperty : INotifyCollectionChanged" +returns = "DependencyProperty" +file = "Extensions\\DependencyPropertyExtensions.cs" +static = true + +[[methods]] +parent = "DependencyPropertyExtensions" +name = "CreateAttachedProperty" +sig = "static DependencyProperty CreateAttachedProperty(string propertyName, TProperty defaultValue = default, FrameworkPropertyMetadataOptions flags = FrameworkPropertyMetadataOptions.None, Action<(TView view, TProperty oldValue, TProperty newValue)> propertyChanged = null, Func<(TView view, TProperty currentValue), TProperty> coerceValue = null, Func validateValue = null) where TView : DependencyObject" +returns = "DependencyProperty" +file = "Extensions\\DependencyPropertyExtensions.cs" +static = true + +[[classes]] +name = "IconExtensions" +ns = "FEx.WPFx.Extensions" +summary = "Icon extensions class." +file = "Extensions\\IconExtensions.cs" +static = true + +[[extensions]] +name = "GetIcon" +returns = "TIcon" +sig = "TIcon GetIcon(this char iconCharacter)" +summary = "Gets the icon." +file = "Extensions\\IconExtensions.cs" + +[[extensions]] +name = "GetIconCharacter" +returns = "char" +sig = "char GetIconCharacter(this Enum value)" +summary = "Gets the icon character." +file = "Extensions\\IconExtensions.cs" + +[[extensions]] +name = "GetAltText" +returns = "string" +sig = "string GetAltText(this Enum value)" +summary = "Gets the alt text." +file = "Extensions\\IconExtensions.cs" + +[[classes]] +name = "TreeViewBuilderExtensions" +ns = "FEx.WPFx.Extensions" +file = "Extensions\\TreeViewBuilderExtensions.cs" +static = true + +[[extensions]] +name = "AddChildNode" +returns = "void" +sig = "void AddChildNode(this ITreeViewBuilder builder, string rootNodeName, List nodePath)" +file = "Extensions\\TreeViewBuilderExtensions.cs" + +[[extensions]] +name = "AddChildNode" +returns = "void" +sig = "void AddChildNode(this ITreeViewBuilder builder, string rootNodeName, List nodePath, string name)" +file = "Extensions\\TreeViewBuilderExtensions.cs" + +[[extensions]] +name = "AddChildNode" +returns = "void" +sig = "void AddChildNode(this ITreeViewBuilder builder, string rootNodeName, List nodePath, string name, bool unique)" +file = "Extensions\\TreeViewBuilderExtensions.cs" + +[[extensions]] +name = "AddChildNode" +returns = "void" +sig = "void AddChildNode(this ITreeViewBuilder builder, string rootNodeName, List nodePath, string name, bool unique, string iconPath)" +file = "Extensions\\TreeViewBuilderExtensions.cs" + +[[extensions]] +name = "AddChildNode" +returns = "void" +sig = "void AddChildNode(this ITreeViewBuilder builder, string rootNodeName, List nodePath, string name, bool unique, string iconPath, bool isIconAttachedToFile)" +file = "Extensions\\TreeViewBuilderExtensions.cs" + +[[extensions]] +name = "AddChildNode" +returns = "void" +sig = "void AddChildNode(this ITreeViewBuilder builder, string rootNodeName, string nodePath)" +file = "Extensions\\TreeViewBuilderExtensions.cs" + +[[extensions]] +name = "AddChildNode" +returns = "void" +sig = "void AddChildNode(this ITreeViewBuilder builder, string rootNodeName, string nodePath, string name)" +file = "Extensions\\TreeViewBuilderExtensions.cs" + +[[extensions]] +name = "AddChildNode" +returns = "void" +sig = "void AddChildNode(this ITreeViewBuilder builder, string rootNodeName, string nodePath, string name, char pathSeparator)" +file = "Extensions\\TreeViewBuilderExtensions.cs" + +[[extensions]] +name = "AddChildNode" +returns = "void" +sig = "void AddChildNode(this ITreeViewBuilder builder, string rootNodeName, string nodePath, string name, char pathSeparator, bool unique)" +file = "Extensions\\TreeViewBuilderExtensions.cs" + +[[extensions]] +name = "AddChildNode" +returns = "void" +sig = "void AddChildNode(this ITreeViewBuilder builder, string rootNodeName, string nodePath, string name, char pathSeparator, bool unique, string iconPath)" +file = "Extensions\\TreeViewBuilderExtensions.cs" + +[[extensions]] +name = "AddChildNodes" +returns = "void" +sig = "void AddChildNodes(this ITreeViewBuilder builder, string rootNodeName, IEnumerable childNodes)" +file = "Extensions\\TreeViewBuilderExtensions.cs" + +[[extensions]] +name = "GrowTreeAsync" +returns = "Task" +sig = "Task GrowTreeAsync(this ITreeViewBuilder builder, ItemsControl tree, IReadOnlyList curr)" +file = "Extensions\\TreeViewBuilderExtensions.cs" + +[[extensions]] +name = "GrowTreeAsync" +returns = "Task" +sig = "Task GrowTreeAsync(this ITreeViewBuilder builder, ItemsControl tree, TItem newNode, int[] location)" +file = "Extensions\\TreeViewBuilderExtensions.cs" + +[[extensions]] +name = "GrowTreeAsync" +returns = "Task" +sig = "Task GrowTreeAsync(this ITreeViewBuilder builder, TItem tree, FExTreeViewNode nodeStub)" +file = "Extensions\\TreeViewBuilderExtensions.cs" + +[[extensions]] +name = "GrowTreeAsync" +returns = "Task" +sig = "Task GrowTreeAsync(this ITreeViewBuilder builder, TItem tree, FExTreeViewNode nodeStub, int locationIndex)" +file = "Extensions\\TreeViewBuilderExtensions.cs" + +[[extensions]] +name = "GrowTreeAsync" +returns = "Task" +sig = "Task GrowTreeAsync(this ITreeViewBuilder builder, TItem tree, FExTreeViewNode nodeStub, IList headers)" +file = "Extensions\\TreeViewBuilderExtensions.cs" + +[[extensions]] +name = "GrowTreeAsync" +returns = "Task" +sig = "Task GrowTreeAsync(this ITreeViewBuilder builder, TItem tree, FExTreeViewNode nodeStub, IList headers, int locationIndex)" +file = "Extensions\\TreeViewBuilderExtensions.cs" + +[[extensions]] +name = "GetTreeNodeAsync" +returns = "Task" +sig = "Task GetTreeNodeAsync(this ITreeViewBuilder builder, string rootNodeName)" +file = "Extensions\\TreeViewBuilderExtensions.cs" + +[[classes]] +name = "TreeViewItemExtensions" +ns = "FEx.WPFx.Extensions" +file = "Extensions\\TreeViewItemExtensions.cs" +static = true + +[[extensions]] +name = "FullPath" +returns = "string" +sig = "string FullPath(this HeaderedItemsControl sender)" +file = "Extensions\\TreeViewItemExtensions.cs" + +[[classes]] +name = "UIElementExtensions" +ns = "FEx.WPFx.Extensions" +file = "Extensions\\UIElementExtensions.cs" +static = true + +[[extensions]] +name = "ExecuteActionOnUIElement" +returns = "void" +sig = "void ExecuteActionOnUIElement(this T element, Action action, bool inUIContext = false)" +file = "Extensions\\UIElementExtensions.cs" + +[[extensions]] +name = "EnableUIElement" +returns = "void" +sig = "void EnableUIElement(this UIElement element, bool inUIContext = false)" +file = "Extensions\\UIElementExtensions.cs" + +[[extensions]] +name = "DisableUIElement" +returns = "void" +sig = "void DisableUIElement(this UIElement element, bool inUIContext = false)" +file = "Extensions\\UIElementExtensions.cs" + +[[classes]] +name = "WindowsExtensions" +ns = "FEx.WPFx.Extensions" +file = "Extensions\\WindowsExtensions.cs" +static = true + +[[extensions]] +name = "GetWindowsScreen" +returns = "Screen" +sig = "Screen GetWindowsScreen(this Window window)" +summary = "Gets the screen on which window is present." +file = "Extensions\\WindowsExtensions.cs" + +[[extensions]] +name = "CenterWindowOnTheScreen" +returns = "void" +sig = "void CenterWindowOnTheScreen(this Window window, Screen screen)" +summary = "Centers the window on the screen." +file = "Extensions\\WindowsExtensions.cs" + +[[extensions]] +name = "GetDpiFactor" +returns = "Point" +sig = "Point GetDpiFactor(this Visual control)" +file = "Extensions\\WindowsExtensions.cs" + +[[extensions]] +name = "CenterWindowOnTopOfTheOwner" +returns = "void" +sig = "void CenterWindowOnTopOfTheOwner(this Window window)" +summary = "Centers the window on top of the owner." +file = "Extensions\\WindowsExtensions.cs" + +[[extensions]] +name = "PlaceToPrimaryMonitor" +returns = "void" +sig = "void PlaceToPrimaryMonitor(this Window window)" +summary = "Places to primary monitor." +file = "Extensions\\WindowsExtensions.cs" + +[[extensions]] +name = "PlaceToMonitor" +returns = "void" +sig = "void PlaceToMonitor(this Window window, Screen screen)" +file = "Extensions\\WindowsExtensions.cs" + +[[classes]] +name = "ResourceIdHelper" +ns = "FEx.WPFx.Helpers" +file = "Helpers\\ResourceIdHelper.cs" +static = true + +[[methods]] +parent = "ResourceIdHelper" +name = "GetResourceIdFromRelativePath" +sig = "static string GetResourceIdFromRelativePath(string relPath)" +returns = "string" +file = "Helpers\\ResourceIdHelper.cs" +static = true + +[[classes]] +name = "WpfCommon" +ns = "FEx.WPFx.Helpers" +file = "Helpers\\WpfCommon.cs" +static = true + +[[properties]] +parent = "WpfCommon" +name = "IsInDesignMode" +sig = "static bool IsInDesignMode { get; }" +returns = "bool" +file = "Helpers\\WpfCommon.cs" +static = true + +[[methods]] +parent = "WpfCommon" +name = "DoEvents" +sig = "static void DoEvents()" +returns = "void" +file = "Helpers\\WpfCommon.cs" +static = true + +[[methods]] +parent = "WpfCommon" +name = "ExitFrame" +sig = "static object ExitFrame(object frame)" +returns = "object" +file = "Helpers\\WpfCommon.cs" +static = true + +[[classes]] +name = "DispatcherContextExecutor" +ns = "FEx.WPFx.Implementations" +base = "FExDispatcher" +file = "Implementations\\DispatcherContextExecutor.cs" + +[[ctors]] +parent = "DispatcherContextExecutor" +sig = "DispatcherContextExecutor(ILogger logger, IMainThreadContextProvider mainThreadContextProvider, IDeadlockMonitor deadlockMonitor, IStackTraceProvider stackTraceProvider)" +file = "Implementations\\DispatcherContextExecutor.cs" + +[[methods]] +parent = "DispatcherContextExecutor" +name = "CheckAccess" +sig = "bool CheckAccess(object sender)" +returns = "bool" +file = "Implementations\\DispatcherContextExecutor.cs" + +[[methods]] +parent = "DispatcherContextExecutor" +name = "BeginInvokeOnMainThread" +sig = "void BeginInvokeOnMainThread(Action action, object sender)" +returns = "void" +file = "Implementations\\DispatcherContextExecutor.cs" + +[[methods]] +parent = "DispatcherContextExecutor" +name = "InvokeOnIdleMainThread" +sig = "void InvokeOnIdleMainThread(Action action, object sender)" +returns = "void" +file = "Implementations\\DispatcherContextExecutor.cs" + +[[methods]] +parent = "DispatcherContextExecutor" +name = "InvokeOnIdleMainThread" +sig = "T InvokeOnIdleMainThread(Func action, object sender)" +returns = "T" +file = "Implementations\\DispatcherContextExecutor.cs" + +[[methods]] +parent = "DispatcherContextExecutor" +name = "InvokeOnMainThread" +sig = "void InvokeOnMainThread(Action action, object sender)" +returns = "void" +file = "Implementations\\DispatcherContextExecutor.cs" + +[[methods]] +parent = "DispatcherContextExecutor" +name = "InvokeOnIdleMainThreadAsync" +sig = "Task InvokeOnIdleMainThreadAsync(Func action, object sender)" +returns = "Task" +file = "Implementations\\DispatcherContextExecutor.cs" + +[[methods]] +parent = "DispatcherContextExecutor" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Action action, object sender)" +returns = "Task" +file = "Implementations\\DispatcherContextExecutor.cs" + +[[methods]] +parent = "DispatcherContextExecutor" +name = "InvokeOnMainThread" +sig = "T InvokeOnMainThread(Func action, object sender)" +returns = "T" +file = "Implementations\\DispatcherContextExecutor.cs" + +[[methods]] +parent = "DispatcherContextExecutor" +name = "InvokeOnIdleMainThreadAsync" +sig = "Task InvokeOnIdleMainThreadAsync(Action action, object sender)" +returns = "Task" +file = "Implementations\\DispatcherContextExecutor.cs" + +[[methods]] +parent = "DispatcherContextExecutor" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func action, object sender)" +returns = "Task" +file = "Implementations\\DispatcherContextExecutor.cs" + +[[methods]] +parent = "DispatcherContextExecutor" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func> funcTask, object sender)" +returns = "Task" +file = "Implementations\\DispatcherContextExecutor.cs" + +[[methods]] +parent = "DispatcherContextExecutor" +name = "InvokeOnMainThreadAsync" +sig = "Task InvokeOnMainThreadAsync(Func funcTask, object sender)" +returns = "Task" +file = "Implementations\\DispatcherContextExecutor.cs" + +[[classes]] +name = "WpfMessagePopupService" +ns = "FEx.WPFx.Implementations" +base = "MessagePopupServiceBase, IDisposable" +file = "Implementations\\WpfMessagePopupService.cs" + +[[ctors]] +parent = "WpfMessagePopupService" +sig = "WpfMessagePopupService(ILogger logger)" +file = "Implementations\\WpfMessagePopupService.cs" + +[[methods]] +parent = "WpfMessagePopupService" +name = "InternalShowMessageAsync" +sig = "Task InternalShowMessageAsync(string txt, string caption, MessageIcon messageBoxImage, FExMessageButton button, ISupportInitialize ownerWindow, bool informUser, bool wait, Stopwatch sw, LogLevel level, Exception exception)" +returns = "Task" +file = "Implementations\\WpfMessagePopupService.cs" + +[[methods]] +parent = "WpfMessagePopupService" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "Implementations\\WpfMessagePopupService.cs" + +[[classes]] +name = "AppConfig" +ns = "FEx.WPFx.Models" +base = "IAppConfig" +file = "Models\\AppConfig.cs" + +[[properties]] +parent = "AppConfig" +name = "MainDesign" +sig = "IViewDesign MainDesign { get; set; }" +returns = "IViewDesign" +file = "Models\\AppConfig.cs" + +[[properties]] +parent = "AppConfig" +name = "SplashDesign" +sig = "IViewDesign SplashDesign { get; set; }" +returns = "IViewDesign" +file = "Models\\AppConfig.cs" + +[[properties]] +parent = "AppConfig" +name = "SplashResourceName" +sig = "string SplashResourceName { get; set; }" +returns = "string" +file = "Models\\AppConfig.cs" + +[[properties]] +parent = "AppConfig" +name = "SplashSize" +sig = "WidthAndHeight SplashSize { get; set; }" +returns = "WidthAndHeight" +file = "Models\\AppConfig.cs" + +[[properties]] +parent = "AppConfig" +name = "ApplicationLogoResourceName" +sig = "string ApplicationLogoResourceName { get; set; }" +returns = "string" +file = "Models\\AppConfig.cs" + +[[properties]] +parent = "AppConfig" +name = "WindowIconName" +sig = "string WindowIconName { get; set; }" +returns = "string" +file = "Models\\AppConfig.cs" + +[[properties]] +parent = "AppConfig" +name = "ApplicationLogo" +sig = "ImageSource ApplicationLogo { get; set; }" +returns = "ImageSource" +file = "Models\\AppConfig.cs" + +[[properties]] +parent = "AppConfig" +name = "WindowIcon" +sig = "Image WindowIcon { get; set; }" +returns = "Image" +file = "Models\\AppConfig.cs" + +[[properties]] +parent = "AppConfig" +name = "ChangelogWindowHeader" +sig = "string ChangelogWindowHeader { get; set; }" +returns = "string" +file = "Models\\AppConfig.cs" + +[[ctors]] +parent = "AppConfig" +sig = "AppConfig()" +file = "Models\\AppConfig.cs" + +[[ctors]] +parent = "AppConfig" +sig = "AppConfig(IViewDesign mainDesign, IViewDesign splashDesign)" +file = "Models\\AppConfig.cs" + +[[ctors]] +parent = "AppConfig" +sig = "AppConfig(IViewDesign mainDesign, IViewDesign splashDesign, string splashResourceName, WidthAndHeight splashSize, string applicationLogoResourceName, string windowIconName, string changelogWindowHeader)" +file = "Models\\AppConfig.cs" + +[[methods]] +parent = "AppConfig" +name = "Initialize" +sig = "void Initialize()" +returns = "void" +file = "Models\\AppConfig.cs" + +[[methods]] +parent = "AppConfig" +name = "GetApplicationResource" +sig = "TResource GetApplicationResource(string resourceName, Func converter) where TResource : class" +returns = "TResource" +file = "Models\\AppConfig.cs" + +[[methods]] +parent = "AppConfig" +name = "GetDefaultApplicationLogo" +sig = "BitmapSource GetDefaultApplicationLogo()" +returns = "BitmapSource" +file = "Models\\AppConfig.cs" + +[[methods]] +parent = "AppConfig" +name = "GetWindowIcon" +sig = "Image GetWindowIcon()" +returns = "Image" +file = "Models\\AppConfig.cs" + +[[methods]] +parent = "AppConfig" +name = "GetApplicationLogo" +sig = "ImageSource GetApplicationLogo()" +returns = "ImageSource" +file = "Models\\AppConfig.cs" + +[[classes]] +name = "HotkeyPayload" +ns = "FEx.WPFx.Models" +file = "Models\\HotkeyPayload.cs" + +[[properties]] +parent = "HotkeyPayload" +name = "KeyGesture" +sig = "KeyGesture KeyGesture { get; }" +returns = "KeyGesture" +file = "Models\\HotkeyPayload.cs" + +[[properties]] +parent = "HotkeyPayload" +name = "Origin" +sig = "ViewModelBase Origin { get; }" +returns = "ViewModelBase" +file = "Models\\HotkeyPayload.cs" + +[[ctors]] +parent = "HotkeyPayload" +sig = "HotkeyPayload(KeyGesture keyGesture, ViewModelBase origin)" +file = "Models\\HotkeyPayload.cs" + +[[classes]] +name = "ViewDesign" +ns = "FEx.WPFx.Models" +base = "NotifyPropertyChanged, IViewDesign" +file = "Models\\ViewDesign.cs" + +[[properties]] +parent = "ViewDesign" +name = "FontSize" +sig = "double FontSize { get; set; }" +returns = "double" +summary = "Gets or sets the size of the font." +file = "Models\\ViewDesign.cs" + +[[properties]] +parent = "ViewDesign" +name = "FontFamily" +sig = "FontFamily FontFamily { get; set; }" +returns = "FontFamily" +file = "Models\\ViewDesign.cs" + +[[properties]] +parent = "ViewDesign" +name = "Background" +sig = "Brush Background { get; set; }" +returns = "Brush" +summary = "Gets or sets the background." +file = "Models\\ViewDesign.cs" + +[[properties]] +parent = "ViewDesign" +name = "ControlBackground" +sig = "Brush ControlBackground { get; set; }" +returns = "Brush" +summary = "Gets or sets the control background." +file = "Models\\ViewDesign.cs" + +[[properties]] +parent = "ViewDesign" +name = "Foreground" +sig = "Brush Foreground { get; set; }" +returns = "Brush" +summary = "Gets or sets the foreground." +file = "Models\\ViewDesign.cs" + +[[properties]] +parent = "ViewDesign" +name = "HeaderBackground" +sig = "Brush HeaderBackground { get; set; }" +returns = "Brush" +summary = "Gets or sets the header background." +file = "Models\\ViewDesign.cs" + +[[properties]] +parent = "ViewDesign" +name = "BorderBackground" +sig = "Brush BorderBackground { get; set; }" +returns = "Brush" +file = "Models\\ViewDesign.cs" + +[[ctors]] +parent = "ViewDesign" +sig = "ViewDesign()" +file = "Models\\ViewDesign.cs" + +[[ctors]] +parent = "ViewDesign" +sig = "ViewDesign(Func backgroundFactory, Func controlBackgroundFactory, Func foregroundFactory, Func headerBackgroundFactory, Func borderBackgroundFactory)" +file = "Models\\ViewDesign.cs" + +[[ctors]] +parent = "ViewDesign" +sig = "ViewDesign(Func backgroundFactory, Func controlBackgroundFactory, Func foregroundFactory, Func headerBackgroundFactory, Func borderBackgroundFactory, FontFamily fontFamily, double fontSize)" +file = "Models\\ViewDesign.cs" + +[[methods]] +parent = "ViewDesign" +name = "Initialize" +sig = "void Initialize()" +returns = "void" +file = "Models\\ViewDesign.cs" + +[[classes]] +name = "CommonWindowsImaging" +ns = "FEx.WPFx.Natives" +file = "Natives\\CommonWindowsImaging.cs" +static = true + +[[methods]] +parent = "CommonWindowsImaging" +name = "ConvertStreamToBitmapImageAsync" +sig = "static Task ConvertStreamToBitmapImageAsync(Stream imageStream)" +returns = "Task" +summary = "Converts the byte array to bitmap image." +file = "Natives\\CommonWindowsImaging.cs" +static = true + +[[methods]] +parent = "CommonWindowsImaging" +name = "GetBitmapImageFromFileAsync" +sig = "static Task GetBitmapImageFromFileAsync(string filePath)" +returns = "Task" +file = "Natives\\CommonWindowsImaging.cs" +static = true + +[[methods]] +parent = "CommonWindowsImaging" +name = "GetBitmapImageFromFileAsync" +sig = "static Task GetBitmapImageFromFileAsync(string filePath, WidthAndHeight size)" +returns = "Task" +file = "Natives\\CommonWindowsImaging.cs" +static = true + +[[methods]] +parent = "CommonWindowsImaging" +name = "GetBitmapImageFromFileAsync" +sig = "static Task GetBitmapImageFromFileAsync(string filePath, WidthAndHeight size, bool forceLoad, bool forceMemoryStream)" +returns = "Task" +file = "Natives\\CommonWindowsImaging.cs" +static = true + +[[methods]] +parent = "CommonWindowsImaging" +name = "GetBitmapImageFromFileAsync" +sig = "static Task GetBitmapImageFromFileAsync(string filePath, WidthAndHeight size, bool forceLoad, bool forceMemoryStream, bool lockOnFile)" +returns = "Task" +file = "Natives\\CommonWindowsImaging.cs" +static = true + +[[methods]] +parent = "CommonWindowsImaging" +name = "GetBitmapImageFromFileAsync" +sig = "static Task GetBitmapImageFromFileAsync(FileInfo file)" +returns = "Task" +file = "Natives\\CommonWindowsImaging.cs" +static = true + +[[methods]] +parent = "CommonWindowsImaging" +name = "GetBitmapImageFromFileAsync" +sig = "static Task GetBitmapImageFromFileAsync(FileInfo file, WidthAndHeight size)" +returns = "Task" +file = "Natives\\CommonWindowsImaging.cs" +static = true + +[[methods]] +parent = "CommonWindowsImaging" +name = "GetBitmapImageFromFileAsync" +sig = "static Task GetBitmapImageFromFileAsync(FileInfo file, WidthAndHeight size, bool forceLoad, bool forceMemoryStream)" +returns = "Task" +file = "Natives\\CommonWindowsImaging.cs" +static = true + +[[methods]] +parent = "CommonWindowsImaging" +name = "GetBitmapImageFromFileAsync" +sig = "static Task GetBitmapImageFromFileAsync(FileInfo file, WidthAndHeight size, bool forceLoad, bool forceMemoryStream, bool lockOnFile)" +returns = "Task" +file = "Natives\\CommonWindowsImaging.cs" +static = true + +[[classes]] +name = "FileUtil" +ns = "FEx.WPFx.Natives" +file = "Natives\\FileUtil.cs" +static = true + +[[methods]] +parent = "FileUtil" +name = "WhoIsLocking" +sig = "static List WhoIsLocking(string path)" +returns = "List" +summary = "Find out what process(es) have a lock on the specified file." +file = "Natives\\FileUtil.cs" +static = true + +[[enums]] +name = "RM_APP_TYPE" +ns = "FEx.WPFx.Natives" +file = "Natives\\FileUtil.cs" + +[[classes]] +name = "Minmaxinfo" +ns = "FEx.WPFx.Natives" +file = "Natives\\MINMAXINFO.cs" + +[[classes]] +name = "Monitorinfo" +ns = "FEx.WPFx.Natives" +file = "Natives\\MONITORINFO.cs" + +[[properties]] +parent = "Monitorinfo" +name = "CbSize" +sig = "int CbSize { get; set; }" +returns = "int" +summary = "The cb size" +file = "Natives\\MONITORINFO.cs" + +[[properties]] +parent = "Monitorinfo" +name = "RcMonitor" +sig = "RectStruct RcMonitor { get; set; }" +returns = "RectStruct" +summary = "The rc monitor" +file = "Natives\\MONITORINFO.cs" + +[[properties]] +parent = "Monitorinfo" +name = "RcWork" +sig = "RectStruct RcWork { get; set; }" +returns = "RectStruct" +summary = "The rc work" +file = "Natives\\MONITORINFO.cs" + +[[properties]] +parent = "Monitorinfo" +name = "DwFlags" +sig = "int DwFlags { get; set; }" +returns = "int" +summary = "The dw flags" +file = "Natives\\MONITORINFO.cs" + +[[classes]] +name = "NativeImagingMethods" +ns = "FEx.WPFx.Natives" +summary = "Contains the external references to the unmanaged code." +file = "Natives\\NativeImagingMethods.cs" +static = true + +[[methods]] +parent = "NativeImagingMethods" +name = "DeleteBitmapObject" +sig = "static void DeleteBitmapObject(IntPtr handle)" +returns = "void" +file = "Natives\\NativeImagingMethods.cs" +static = true + +[[classes]] +name = "NativeMethods" +ns = "FEx.WPFx.Natives" +summary = "Contains the external references to the unmanaged code." +file = "Natives\\NativeMethods.cs" +static = true + +[[extensions]] +name = "BringOnTop" +returns = "void" +sig = "void BringOnTop(this Window window)" +summary = "Brings window to the foreground." +file = "Natives\\NativeMethods.cs" + +[[methods]] +parent = "NativeMethods" +name = "GetLastError" +sig = "static Win32Exception GetLastError()" +returns = "Win32Exception" +summary = "Gets the last error." +file = "Natives\\NativeMethods.cs" +static = true + +[[methods]] +parent = "NativeMethods" +name = "GetRootWindowsOfProcess" +sig = "static List> GetRootWindowsOfProcess()" +returns = "List>" +summary = "Gets the root windows of process." +file = "Natives\\NativeMethods.cs" +static = true + +[[methods]] +parent = "NativeMethods" +name = "GetRootWindowsOfProcess" +sig = "static List> GetRootWindowsOfProcess(Process process)" +returns = "List>" +file = "Natives\\NativeMethods.cs" +static = true + +[[methods]] +parent = "NativeMethods" +name = "WmGetMinMaxInfo" +sig = "static void WmGetMinMaxInfo(IntPtr hwnd, IntPtr lParam)" +returns = "void" +file = "Natives\\NativeMethods.cs" +static = true + +[[extensions]] +name = "MaximizeWindow" +returns = "void" +sig = "void MaximizeWindow(this Process proc)" +file = "Natives\\NativeMethods.cs" + +[[extensions]] +name = "MaximizeWindow" +returns = "void" +sig = "void MaximizeWindow(this IntPtr hwnd)" +file = "Natives\\NativeMethods.cs" + +[[extensions]] +name = "MinimizeWindow" +returns = "void" +sig = "void MinimizeWindow(this Process proc)" +file = "Natives\\NativeMethods.cs" + +[[extensions]] +name = "MinimizeWindow" +returns = "void" +sig = "void MinimizeWindow(this IntPtr hwnd)" +file = "Natives\\NativeMethods.cs" + +[[classes]] +name = "RectStruct" +ns = "FEx.WPFx.Natives" +summary = "Win32" +file = "Natives\\RectStruct.cs" + +[[properties]] +parent = "RectStruct" +name = "Width" +sig = "int Width { get; }" +returns = "int" +summary = "Win32" +file = "Natives\\RectStruct.cs" + +[[properties]] +parent = "RectStruct" +name = "Height" +sig = "int Height { get; }" +returns = "int" +summary = "Win32" +file = "Natives\\RectStruct.cs" + +[[ctors]] +parent = "RectStruct" +sig = "RectStruct(int left, int top, int right, int bottom)" +summary = "Win32" +file = "Natives\\RectStruct.cs" + +[[ctors]] +parent = "RectStruct" +sig = "RectStruct(RectStruct rcSrc)" +summary = "Win32" +file = "Natives\\RectStruct.cs" + +[[properties]] +parent = "RectStruct" +name = "IsEmpty" +sig = "bool IsEmpty { get; }" +returns = "bool" +summary = "Win32" +file = "Natives\\RectStruct.cs" + +[[methods]] +parent = "RectStruct" +name = "ToString" +sig = "string ToString()" +returns = "string" +summary = "Return a user friendly representation of this struct" +file = "Natives\\RectStruct.cs" + +[[methods]] +parent = "RectStruct" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +summary = "Determine if 2 RECT are equal (deep compare)" +file = "Natives\\RectStruct.cs" + +[[methods]] +parent = "RectStruct" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +summary = "Return the HashCode for this struct (not garanteed to be unique)" +file = "Natives\\RectStruct.cs" + +[[classes]] +name = "ScreenPoint" +ns = "FEx.WPFx.Natives" +summary = "POINT aka POINTAPI" +file = "Natives\\ScreenPoint.cs" + +[[ctors]] +parent = "ScreenPoint" +sig = "ScreenPoint(int x, int y)" +summary = "Construct a point of coordinates (x,y)." +file = "Natives\\ScreenPoint.cs" + +[[classes]] +name = "ShellIcon" +ns = "FEx.WPFx.Natives" +summary = "Get a small or large Icon with an easy C# function call that returns a 32x32 or 16x16 System.Drawing.Icon depending on which function you call either GetSmallIcon(string fileName) or GetLargeIcon(string fileName)" +file = "Natives\\ShellIcon.cs" +static = true + +[[methods]] +parent = "ShellIcon" +name = "GetSmallFolderIcon" +sig = "static Icon GetSmallFolderIcon()" +returns = "Icon" +file = "Natives\\ShellIcon.cs" +static = true + +[[methods]] +parent = "ShellIcon" +name = "GetLargeFolderIcon" +sig = "static Icon GetLargeFolderIcon()" +returns = "Icon" +file = "Natives\\ShellIcon.cs" +static = true + +[[methods]] +parent = "ShellIcon" +name = "GetSmallIcon" +sig = "static Icon GetSmallIcon(string fileName)" +returns = "Icon" +file = "Natives\\ShellIcon.cs" +static = true + +[[methods]] +parent = "ShellIcon" +name = "GetLargeIcon" +sig = "static Icon GetLargeIcon(string fileName)" +returns = "Icon" +file = "Natives\\ShellIcon.cs" +static = true + +[[methods]] +parent = "ShellIcon" +name = "GetSmallIconFromExtension" +sig = "static Icon GetSmallIconFromExtension(string extension)" +returns = "Icon" +file = "Natives\\ShellIcon.cs" +static = true + +[[methods]] +parent = "ShellIcon" +name = "GetLargeIconFromExtension" +sig = "static Icon GetLargeIconFromExtension(string extension)" +returns = "Icon" +file = "Natives\\ShellIcon.cs" +static = true + +[[classes]] +name = "SHFileInfo" +ns = "FEx.WPFx.Natives" +file = "Natives\\SHFileInfo.cs" + +[[enums]] +name = "SHGFI" +ns = "FEx.WPFx.Natives" +file = "Natives\\SHGFI.cs" + +[[enums]] +name = "ShowWindow" +ns = "FEx.WPFx.Natives" +file = "Natives\\ShowWindow.cs" + +[[classes]] +name = "Win32" +ns = "FEx.WPFx.Natives" +file = "Natives\\Win32.cs" +static = true + +[[methods]] +parent = "Win32" +name = "GetFileInfo" +sig = "static IntPtr GetFileInfo(string pszPath, uint dwFileAttributes, ref SHFileInfo psfi, uint cbSizeFileInfo, uint uFlags)" +returns = "IntPtr" +file = "Natives\\Win32.cs" +static = true + +[[methods]] +parent = "Win32" +name = "DestroySHIcon" +sig = "static void DestroySHIcon(SHFileInfo shinfo)" +returns = "void" +file = "Natives\\Win32.cs" +static = true + +[[classes]] +name = "DispatcherService" +ns = "FEx.WPFx.Services" +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "InvokeOnDispatcherContext" +sig = "static void InvokeOnDispatcherContext(Action action)" +returns = "void" +summary = "Executes the action in dispatcher context by checking if action should be invoked by dispatcher asynchronously, or directly, and running it." +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "InvokeOnDispatcherContext" +sig = "static void InvokeOnDispatcherContext(Action action, DispatcherObject sender)" +returns = "void" +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "InvokeOnDispatcherContext" +sig = "static void InvokeOnDispatcherContext(Action action, DispatcherObject sender, DispatcherPriority priority)" +returns = "void" +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "InvokeOnDispatcherContextAsync" +sig = "static Task InvokeOnDispatcherContextAsync(Action action)" +returns = "Task" +summary = "Executes the action in dispatcher context by checking if action should be invoked by dispatcher asynchronously, or directly, and running it." +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "InvokeOnDispatcherContextAsync" +sig = "static Task InvokeOnDispatcherContextAsync(Action action, DispatcherObject sender)" +returns = "Task" +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "InvokeOnDispatcherContextAsync" +sig = "static Task InvokeOnDispatcherContextAsync(Action action, DispatcherObject sender, DispatcherPriority priority)" +returns = "Task" +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "InvokeOnDispatcherContext" +sig = "static T InvokeOnDispatcherContext(Func action)" +returns = "T" +summary = "Executes the action in dispatcher context by checking if action should be invoked by dispatcher, or directly, and running it." +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "InvokeOnDispatcherContext" +sig = "static T InvokeOnDispatcherContext(Func action, DispatcherObject sender)" +returns = "T" +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "InvokeOnDispatcherContext" +sig = "static T InvokeOnDispatcherContext(Func action, DispatcherObject sender, DispatcherPriority priority)" +returns = "T" +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "InvokeOnDispatcherContextAsync" +sig = "static Task InvokeOnDispatcherContextAsync(Func action)" +returns = "Task" +summary = "Executes the action in dispatcher context by checking if action should be invoked by dispatcher, or directly, and running it." +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "InvokeOnDispatcherContextAsync" +sig = "static Task InvokeOnDispatcherContextAsync(Func action, DispatcherObject sender)" +returns = "Task" +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "InvokeOnDispatcherContextAsync" +sig = "static Task InvokeOnDispatcherContextAsync(Func action, DispatcherObject sender, DispatcherPriority priority)" +returns = "Task" +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "InvokeOnDispatcherContextAsync" +sig = "static Task InvokeOnDispatcherContextAsync(Func action, DispatcherObject sender, DispatcherPriority priority, CancellationToken cancellationToken)" +returns = "Task" +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "ExecuteTaskInDispatcherContextAsync" +sig = "static Task ExecuteTaskInDispatcherContextAsync(Func funcTask)" +returns = "Task" +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "ExecuteTaskInDispatcherContextAsync" +sig = "static Task ExecuteTaskInDispatcherContextAsync(Func funcTask, DispatcherObject sender)" +returns = "Task" +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "ExecuteTaskInDispatcherContextAsync" +sig = "static Task ExecuteTaskInDispatcherContextAsync(Func funcTask, DispatcherObject sender, DispatcherPriority priority)" +returns = "Task" +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "ExecuteTaskInDispatcherContextAsync" +sig = "static Task ExecuteTaskInDispatcherContextAsync(Func> funcTask)" +returns = "Task" +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "ExecuteTaskInDispatcherContextAsync" +sig = "static Task ExecuteTaskInDispatcherContextAsync(Func> funcTask, DispatcherObject sender)" +returns = "Task" +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "ExecuteTaskInDispatcherContextAsync" +sig = "static Task ExecuteTaskInDispatcherContextAsync(Func> funcTask, DispatcherObject sender, DispatcherPriority priority)" +returns = "Task" +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "ShowView" +sig = "static TaskCompletionSource ShowView(Func viewFunc) where T : Window" +returns = "TaskCompletionSource" +summary = "Shows the view and waits until it's closed." +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "ShowView" +sig = "static TaskCompletionSource ShowView(Func viewFunc, bool isModal) where T : Window" +returns = "TaskCompletionSource" +file = "Services\\DispatcherService.cs" +static = true + +[[extensions]] +name = "GetDispatcherObject" +returns = "DispatcherObject" +sig = "DispatcherObject GetDispatcherObject(this DispatcherObject sender)" +file = "Services\\DispatcherService.cs" + +[[methods]] +parent = "DispatcherService" +name = "CheckAccess" +sig = "static bool CheckAccess(DispatcherObject sender)" +returns = "bool" +summary = "Checks the access." +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "BeginInvoke" +sig = "static void BeginInvoke(Action action)" +returns = "void" +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "BeginInvoke" +sig = "static void BeginInvoke(Action action, DispatcherObject sender)" +returns = "void" +file = "Services\\DispatcherService.cs" +static = true + +[[methods]] +parent = "DispatcherService" +name = "BeginInvoke" +sig = "static void BeginInvoke(Action action, DispatcherObject sender, DispatcherPriority priority)" +returns = "void" +file = "Services\\DispatcherService.cs" +static = true + +[[classes]] +name = "WpfProgressStatusContainer" +ns = "FEx.WPFx.Services" +base = "ProgressAggregator, IWpfProgressStatusContainer" +file = "Services\\WpfProgressStatusContainer.cs" + +[[properties]] +parent = "WpfProgressStatusContainer" +name = "TaskbarProgressState" +sig = "TaskbarItemProgressState TaskbarProgressState { get; set; }" +returns = "TaskbarItemProgressState" +file = "Services\\WpfProgressStatusContainer.cs" + +[[properties]] +parent = "WpfProgressStatusContainer" +name = "PrgInfoVisibility" +sig = "Visibility PrgInfoVisibility { get; set; }" +returns = "Visibility" +file = "Services\\WpfProgressStatusContainer.cs" + +[[methods]] +parent = "WpfProgressStatusContainer" +name = "Report" +sig = "void Report(string propertyName, object value)" +returns = "void" +file = "Services\\WpfProgressStatusContainer.cs" + +[[methods]] +parent = "WpfProgressStatusContainer" +name = "GetProperties" +sig = "List GetProperties()" +returns = "List" +file = "Services\\WpfProgressStatusContainer.cs" + +[[methods]] +parent = "WpfProgressStatusContainer" +name = "SetIsIndeterminate" +sig = "void SetIsIndeterminate(bool value)" +returns = "void" +file = "Services\\WpfProgressStatusContainer.cs" + +[[methods]] +parent = "WpfProgressStatusContainer" +name = "SetPrecisePercentage" +sig = "void SetPrecisePercentage(double value)" +returns = "void" +file = "Services\\WpfProgressStatusContainer.cs" + +[[methods]] +parent = "WpfProgressStatusContainer" +name = "SetIsInfoVisible" +sig = "void SetIsInfoVisible(bool? value)" +returns = "void" +file = "Services\\WpfProgressStatusContainer.cs" + +[[methods]] +parent = "WpfProgressStatusContainer" +name = "SetPrgState" +sig = "void SetPrgState(TaskbarItemProgressState value)" +returns = "void" +file = "Services\\WpfProgressStatusContainer.cs" + +[[methods]] +parent = "WpfProgressStatusContainer" +name = "SetProgressState" +sig = "void SetProgressState()" +returns = "void" +file = "Services\\WpfProgressStatusContainer.cs" + +[[classes]] +name = "SvgCommon" +ns = "FEx.WPFx.SVG" +file = "SVG\\SvgCommon.cs" +static = true + +[[methods]] +parent = "SvgCommon" +name = "ConvertSvgFileToDrawingImage" +sig = "static DrawingImage ConvertSvgFileToDrawingImage(string filepath)" +returns = "DrawingImage" +summary = "Converts the SVG file to ." +file = "SVG\\SvgCommon.cs" +static = true + +[[methods]] +parent = "SvgCommon" +name = "ConvertSvgToDrawingImage" +sig = "static DrawingImage ConvertSvgToDrawingImage(string svg, string fileName)" +returns = "DrawingImage" +summary = "Converts the SVG to image source." +file = "SVG\\SvgCommon.cs" +static = true + +[[extensions]] +name = "ToMemoryStream" +returns = "MemoryStream" +sig = "MemoryStream ToMemoryStream(this DrawingImage drawingImage)" +file = "SVG\\SvgCommon.cs" + +[[extensions]] +name = "ToRenderTargetBitmap" +returns = "RenderTargetBitmap" +sig = "RenderTargetBitmap ToRenderTargetBitmap(this DrawingImage source)" +file = "SVG\\SvgCommon.cs" + +[[classes]] +name = "NotEmptyValidationRule" +ns = "FEx.WPFx.Validation" +base = "ValidationRule" +file = "Validation\\NotEmptyValidationRule.cs" + +[[methods]] +parent = "NotEmptyValidationRule" +name = "Validate" +sig = "ValidationResult Validate(object value, CultureInfo cultureInfo)" +returns = "ValidationResult" +file = "Validation\\NotEmptyValidationRule.cs" + +[[interfaces]] +name = "IWpfProgressInfo" +ns = "FEx.WPFx.ViewModels" +base = "IProgressAggregator" +file = "ViewModels\\IWpfProgressInfo.cs" + +[[properties]] +parent = "IWpfProgressInfo" +name = "ProgressState" +sig = "TaskbarItemProgressState ProgressState { get; set; }" +returns = "TaskbarItemProgressState" +file = "ViewModels\\IWpfProgressInfo.cs" + +[[properties]] +parent = "IWpfProgressInfo" +name = "PrgInfoVisibility" +sig = "Visibility PrgInfoVisibility { get; set; }" +returns = "Visibility" +file = "ViewModels\\IWpfProgressInfo.cs" + +[[interfaces]] +name = "IWpfProgressInfoGet" +ns = "FEx.WPFx.ViewModels" +base = "IProgressAggregator" +file = "ViewModels\\IWpfProgressInfo.cs" + +[[properties]] +parent = "IWpfProgressInfoGet" +name = "TaskbarProgressState" +sig = "TaskbarItemProgressState TaskbarProgressState { get; }" +returns = "TaskbarItemProgressState" +file = "ViewModels\\IWpfProgressInfo.cs" + +[[properties]] +parent = "IWpfProgressInfoGet" +name = "PrgInfoVisibility" +sig = "Visibility PrgInfoVisibility { get; }" +returns = "Visibility" +file = "ViewModels\\IWpfProgressInfo.cs" + +[[interfaces]] +name = "IWpfProgressListenerViewModel" +ns = "FEx.WPFx.ViewModels" +base = "IWpfProgressReceiver, IThreadingAwareViewModel" +file = "ViewModels\\IWpfProgressListenerViewModel.cs" + +[[properties]] +parent = "IWpfProgressListenerViewModel" +name = "View" +sig = "ContentControl View { get; set; }" +returns = "ContentControl" +file = "ViewModels\\IWpfProgressListenerViewModel.cs" + +[[properties]] +parent = "IWpfProgressListenerViewModel" +name = "ViewName" +sig = "string ViewName { get; set; }" +returns = "string" +file = "ViewModels\\IWpfProgressListenerViewModel.cs" + +[[interfaces]] +name = "IWpfProgressReceiver" +ns = "FEx.WPFx.ViewModels" +base = "IProgressReceiver" +file = "ViewModels\\IWpfProgressReceiver.cs" + +[[interfaces]] +name = "IWpfProgressStatusContainer" +ns = "FEx.WPFx.ViewModels" +base = "IWpfProgressInfoGet" +file = "ViewModels\\IWpfProgressStatusContainer.cs" + +[[methods]] +parent = "IWpfProgressStatusContainer" +name = "SetPrgState" +sig = "void SetPrgState(TaskbarItemProgressState value)" +returns = "void" +file = "ViewModels\\IWpfProgressStatusContainer.cs" + +[[classes]] +name = "WpfProgressListenerViewModel" +ns = "FEx.WPFx.ViewModels" +base = "ProgressListenerViewModel, IWpfProgressListenerViewModel" +file = "ViewModels\\WpfProgressListenerViewModel.cs" + +[[properties]] +parent = "WpfProgressListenerViewModel" +name = "View" +sig = "ContentControl View { get; set; }" +returns = "ContentControl" +file = "ViewModels\\WpfProgressListenerViewModel.cs" + +[[properties]] +parent = "WpfProgressListenerViewModel" +name = "ViewName" +sig = "string ViewName { get; set; }" +returns = "string" +file = "ViewModels\\WpfProgressListenerViewModel.cs" + +[[properties]] +parent = "WpfProgressListenerViewModel" +name = "Design" +sig = "IViewDesign Design { get; set; }" +returns = "IViewDesign" +file = "ViewModels\\WpfProgressListenerViewModel.cs" + +[[ctors]] +parent = "WpfProgressListenerViewModel" +sig = "WpfProgressListenerViewModel(bool useMainProgressContainer = false, params IAsyncInitializable[] dependencies)" +file = "ViewModels\\WpfProgressListenerViewModel.cs" + +[[methods]] +parent = "WpfProgressListenerViewModel" +name = "GetIsInDesignMode" +sig = "bool GetIsInDesignMode()" +returns = "bool" +file = "ViewModels\\WpfProgressListenerViewModel.cs" + +[[classes]] +name = "BindingErrorListener" +ns = "FEx.WPFx.WpfBindingErrors" +base = "IDisposable" +summary = "Raises an event each time a WPF Binding error occurs." +file = "WpfBindingErrors\\BindingErrorListener.cs" + +[[ctors]] +parent = "BindingErrorListener" +sig = "BindingErrorListener()" +file = "WpfBindingErrors\\BindingErrorListener.cs" + +[[methods]] +parent = "BindingErrorListener" +name = "Dispose" +sig = "void Dispose()" +returns = "void" +file = "WpfBindingErrors\\BindingErrorListener.cs" + +[[classes]] +name = "BindingException" +ns = "FEx.WPFx.WpfBindingErrors" +base = "Exception" +summary = "Exception thrown by the BindingExceptionThrower each time a WPF binding error occurs" +file = "WpfBindingErrors\\BindingException.cs" + +[[properties]] +parent = "BindingException" +name = "StackTrace" +sig = "string StackTrace { get; }" +returns = "string" +file = "WpfBindingErrors\\BindingException.cs" + +[[properties]] +parent = "BindingException" +name = "OccurenceTime" +sig = "DateTime OccurenceTime { get; }" +returns = "DateTime" +file = "WpfBindingErrors\\BindingException.cs" + +[[ctors]] +parent = "BindingException" +sig = "BindingException(TraceEventCache eventCache, string source, string message)" +file = "WpfBindingErrors\\BindingException.cs" + +[[ctors]] +parent = "BindingException" +sig = "BindingException(string message)" +file = "WpfBindingErrors\\BindingException.cs" + +[[ctors]] +parent = "BindingException" +sig = "BindingException()" +file = "WpfBindingErrors\\BindingException.cs" + +[[ctors]] +parent = "BindingException" +sig = "BindingException(string message, Exception innerException)" +file = "WpfBindingErrors\\BindingException.cs" + +[[methods]] +parent = "BindingException" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +file = "WpfBindingErrors\\BindingException.cs" + +[[methods]] +parent = "BindingException" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +file = "WpfBindingErrors\\BindingException.cs" + +[[methods]] +parent = "BindingException" +name = "Equals" +sig = "bool Equals(BindingException other)" +returns = "bool" +file = "WpfBindingErrors\\BindingException.cs" + +[[classes]] +name = "BindingExceptionThrower" +ns = "FEx.WPFx.WpfBindingErrors" +summary = "Converts WPF binding error into BindingException" +file = "WpfBindingErrors\\BindingExceptionThrower.cs" +static = true + +[[properties]] +parent = "BindingExceptionThrower" +name = "DefaultSettings" +sig = "static JsonSerializerSettings DefaultSettings { get; }" +returns = "JsonSerializerSettings" +file = "WpfBindingErrors\\BindingExceptionThrower.cs" +static = true + +[[properties]] +parent = "BindingExceptionThrower" +name = "IsAttached" +sig = "static bool IsAttached { get; }" +returns = "bool" +summary = "Gets a value indicating whether this instance is attached." +file = "WpfBindingErrors\\BindingExceptionThrower.cs" +static = true + +[[methods]] +parent = "BindingExceptionThrower" +name = "Attach" +sig = "static void Attach(string bindingErrorsCacheDirectory)" +returns = "void" +summary = "Start listening WPF binding error" +file = "WpfBindingErrors\\BindingExceptionThrower.cs" +static = true + +[[methods]] +parent = "BindingExceptionThrower" +name = "Detach" +sig = "static void Detach()" +returns = "void" +summary = "Stop listening WPF binding error" +file = "WpfBindingErrors\\BindingExceptionThrower.cs" +static = true + +[[classes]] +name = "ObservableTraceListener" +ns = "FEx.WPFx.WpfBindingErrors" +base = "TraceListener" +summary = "A TraceListener that raise an event each time a trace is written" +file = "WpfBindingErrors\\ObservableTraceListener.cs" + +[[methods]] +parent = "ObservableTraceListener" +name = "Write" +sig = "void Write(string message)" +returns = "void" +file = "WpfBindingErrors\\ObservableTraceListener.cs" + +[[methods]] +parent = "ObservableTraceListener" +name = "WriteLine" +sig = "void WriteLine(string message)" +returns = "void" +file = "WpfBindingErrors\\ObservableTraceListener.cs" + +[[methods]] +parent = "ObservableTraceListener" +name = "TraceEvent" +sig = "void TraceEvent(TraceEventCache eventCache, string source, TraceEventType eventType, int id)" +returns = "void" +file = "WpfBindingErrors\\ObservableTraceListener.cs" + +[[methods]] +parent = "ObservableTraceListener" +name = "TraceEvent" +sig = "void TraceEvent(TraceEventCache eventCache, string source, TraceEventType eventType, int id, string message)" +returns = "void" +file = "WpfBindingErrors\\ObservableTraceListener.cs" + +[[methods]] +parent = "ObservableTraceListener" +name = "TraceEvent" +sig = "void TraceEvent(TraceEventCache eventCache, string source, TraceEventType eventType, int id, string format, params object[] args)" +returns = "void" +file = "WpfBindingErrors\\ObservableTraceListener.cs" + +[[interfaces]] +name = "IAppConfig" +ns = "FEx.WPFx.Abstractions.Interfaces" +file = "Abstractions\\Interfaces\\IAppConfig.cs" + +[[properties]] +parent = "IAppConfig" +name = "SplashDesign" +sig = "IViewDesign SplashDesign { get; }" +returns = "IViewDesign" +file = "Abstractions\\Interfaces\\IAppConfig.cs" + +[[properties]] +parent = "IAppConfig" +name = "MainDesign" +sig = "IViewDesign MainDesign { get; }" +returns = "IViewDesign" +file = "Abstractions\\Interfaces\\IAppConfig.cs" + +[[properties]] +parent = "IAppConfig" +name = "SplashResourceName" +sig = "string SplashResourceName { get; }" +returns = "string" +file = "Abstractions\\Interfaces\\IAppConfig.cs" + +[[properties]] +parent = "IAppConfig" +name = "SplashSize" +sig = "WidthAndHeight SplashSize { get; }" +returns = "WidthAndHeight" +file = "Abstractions\\Interfaces\\IAppConfig.cs" + +[[properties]] +parent = "IAppConfig" +name = "ApplicationLogoResourceName" +sig = "string ApplicationLogoResourceName { get; }" +returns = "string" +file = "Abstractions\\Interfaces\\IAppConfig.cs" + +[[properties]] +parent = "IAppConfig" +name = "WindowIconName" +sig = "string WindowIconName { get; }" +returns = "string" +file = "Abstractions\\Interfaces\\IAppConfig.cs" + +[[properties]] +parent = "IAppConfig" +name = "ApplicationLogo" +sig = "ImageSource ApplicationLogo { get; }" +returns = "ImageSource" +file = "Abstractions\\Interfaces\\IAppConfig.cs" + +[[properties]] +parent = "IAppConfig" +name = "WindowIcon" +sig = "Image WindowIcon { get; }" +returns = "Image" +file = "Abstractions\\Interfaces\\IAppConfig.cs" + +[[properties]] +parent = "IAppConfig" +name = "ChangelogWindowHeader" +sig = "string ChangelogWindowHeader { get; }" +returns = "string" +file = "Abstractions\\Interfaces\\IAppConfig.cs" + +[[methods]] +parent = "IAppConfig" +name = "Initialize" +sig = "void Initialize()" +returns = "void" +file = "Abstractions\\Interfaces\\IAppConfig.cs" + +[[interfaces]] +name = "IFExContainer" +ns = "FEx.WPFx.Abstractions.Interfaces" +base = "IFExBaseContainer, IFExMvvmContainer, IFExJsonContainer, IFExMvvmRxContainer, IFExPlatformsContainer, IFExWpfxContainer" +file = "Abstractions\\Interfaces\\IFExContainer.cs" + +[[interfaces]] +name = "IFExWpfxContainer" +ns = "FEx.WPFx.Abstractions.Interfaces" +base = "IContainer, IContainer, IContainer, IContainer>, IContainer, IContainer" +file = "Abstractions\\Interfaces\\IFExWpfxContainer.cs" + +[[interfaces]] +name = "ITreeViewBuilder" +ns = "FEx.WPFx.Abstractions.Interfaces" +file = "Abstractions\\Interfaces\\ITreeViewBuilder.cs" + +[[methods]] +parent = "ITreeViewBuilder" +name = "CreateNewNode" +sig = "void CreateNewNode(FExTreeViewNode node)" +returns = "void" +file = "Abstractions\\Interfaces\\ITreeViewBuilder.cs" + +[[methods]] +parent = "ITreeViewBuilder" +name = "CreateNewNode" +sig = "void CreateNewNode(string nodePath)" +returns = "void" +file = "Abstractions\\Interfaces\\ITreeViewBuilder.cs" + +[[methods]] +parent = "ITreeViewBuilder" +name = "AddChildNode" +sig = "void AddChildNode(string rootNodeName, List nodePath, string name, bool unique, string iconPath, bool isIconAttachedToFile, bool isExpanded)" +returns = "void" +file = "Abstractions\\Interfaces\\ITreeViewBuilder.cs" + +[[methods]] +parent = "ITreeViewBuilder" +name = "AddChildNode" +sig = "void AddChildNode(string rootNodeName, string nodePath, string name, char pathSeparator, bool unique, string iconPath, bool isExpanded)" +returns = "void" +file = "Abstractions\\Interfaces\\ITreeViewBuilder.cs" + +[[methods]] +parent = "ITreeViewBuilder" +name = "AddChildNodes" +sig = "void AddChildNodes(string rootNodeName, IEnumerable childNodes, bool unique)" +returns = "void" +file = "Abstractions\\Interfaces\\ITreeViewBuilder.cs" + +[[interfaces]] +name = "ITreeViewBuilder" +ns = "FEx.WPFx.Abstractions.Interfaces" +base = "ITreeViewBuilder" +file = "Abstractions\\Interfaces\\ITreeViewBuilder.cs" + +[[methods]] +parent = "ITreeViewBuilder" +name = "GetTreeViewItemAsync" +sig = "Task GetTreeViewItemAsync(FExTreeViewNode nodeStub)" +returns = "Task" +file = "Abstractions\\Interfaces\\ITreeViewBuilder.cs" + +[[methods]] +parent = "ITreeViewBuilder" +name = "GrowTreeAsync" +sig = "Task GrowTreeAsync(ItemsControl tree, IReadOnlyList curr, int i)" +returns = "Task" +file = "Abstractions\\Interfaces\\ITreeViewBuilder.cs" + +[[methods]] +parent = "ITreeViewBuilder" +name = "GrowTreeAsync" +sig = "Task GrowTreeAsync(ItemsControl tree, TItem newNode, int[] location, int i)" +returns = "Task" +summary = "Grows the tree." +file = "Abstractions\\Interfaces\\ITreeViewBuilder.cs" + +[[methods]] +parent = "ITreeViewBuilder" +name = "GrowTreeAsync" +sig = "Task GrowTreeAsync(TItem tree, FExTreeViewNode nodeStub, int locationIndex, bool setDirectoriesIcons)" +returns = "Task" +summary = "Grows the tree." +file = "Abstractions\\Interfaces\\ITreeViewBuilder.cs" + +[[methods]] +parent = "ITreeViewBuilder" +name = "GrowTreeAsync" +sig = "Task GrowTreeAsync(TItem tree, FExTreeViewNode nodeStub, IList headers, int locationIndex, bool setDirectoriesIcons)" +returns = "Task" +file = "Abstractions\\Interfaces\\ITreeViewBuilder.cs" + +[[methods]] +parent = "ITreeViewBuilder" +name = "GetTreeNodeAsync" +sig = "Task GetTreeNodeAsync(string rootNodeName, bool setDirectoriesIcons)" +returns = "Task" +file = "Abstractions\\Interfaces\\ITreeViewBuilder.cs" + +[[interfaces]] +name = "IViewDesign" +ns = "FEx.WPFx.Abstractions.Interfaces" +file = "Abstractions\\Interfaces\\IViewDesign.cs" + +[[properties]] +parent = "IViewDesign" +name = "FontSize" +sig = "double FontSize { get; set; }" +returns = "double" +file = "Abstractions\\Interfaces\\IViewDesign.cs" + +[[properties]] +parent = "IViewDesign" +name = "FontFamily" +sig = "FontFamily FontFamily { get; set; }" +returns = "FontFamily" +file = "Abstractions\\Interfaces\\IViewDesign.cs" + +[[properties]] +parent = "IViewDesign" +name = "Background" +sig = "Brush Background { get; set; }" +returns = "Brush" +file = "Abstractions\\Interfaces\\IViewDesign.cs" + +[[properties]] +parent = "IViewDesign" +name = "ControlBackground" +sig = "Brush ControlBackground { get; set; }" +returns = "Brush" +file = "Abstractions\\Interfaces\\IViewDesign.cs" + +[[properties]] +parent = "IViewDesign" +name = "Foreground" +sig = "Brush Foreground { get; set; }" +returns = "Brush" +file = "Abstractions\\Interfaces\\IViewDesign.cs" + +[[properties]] +parent = "IViewDesign" +name = "HeaderBackground" +sig = "Brush HeaderBackground { get; set; }" +returns = "Brush" +file = "Abstractions\\Interfaces\\IViewDesign.cs" + +[[properties]] +parent = "IViewDesign" +name = "BorderBackground" +sig = "Brush BorderBackground { get; set; }" +returns = "Brush" +file = "Abstractions\\Interfaces\\IViewDesign.cs" + +[[methods]] +parent = "IViewDesign" +name = "Initialize" +sig = "void Initialize()" +returns = "void" +file = "Abstractions\\Interfaces\\IViewDesign.cs" + +[[interfaces]] +name = "IChildrenCollection" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +file = "Controls\\VirtualizingWrapPanelControl\\ChildrenCollection.cs" + +[[methods]] +parent = "IChildrenCollection" +name = "AddChild" +sig = "void AddChild(IItemContainerInfo child)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\ChildrenCollection.cs" + +[[methods]] +parent = "IChildrenCollection" +name = "RemoveChild" +sig = "void RemoveChild(IItemContainerInfo child)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\ChildrenCollection.cs" + +[[classes]] +name = "VirtualizingPanelWrapper" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +base = "IChildrenCollection" +file = "Controls\\VirtualizingWrapPanelControl\\ChildrenCollection.cs" + +[[ctors]] +parent = "VirtualizingPanelWrapper" +sig = "VirtualizingPanelWrapper(Action addInternalChild, Action removetInternalChild)" +file = "Controls\\VirtualizingWrapPanelControl\\ChildrenCollection.cs" + +[[methods]] +parent = "VirtualizingPanelWrapper" +name = "AddChild" +sig = "void AddChild(IItemContainerInfo containerInfo)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\ChildrenCollection.cs" + +[[methods]] +parent = "VirtualizingPanelWrapper" +name = "RemoveChild" +sig = "void RemoveChild(IItemContainerInfo containerInfo)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\ChildrenCollection.cs" + +[[classes]] +name = "GridDetailsView" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +base = "GridView" +summary = "Simple control that displays a gird of items. Depending on the orientation, the items are either stacked horizontally or vertically until the items are wrapped to the next row or column. The control is using virtualization to support large amount of items. If an item is clicked the item gots expanded until it is clicked again or an other item is clicked and gots expanded. In order to work properly all items must have the same size." +file = "Controls\\VirtualizingWrapPanelControl\\GridDetailsView.xaml.cs" + +[[properties]] +parent = "GridDetailsView" +name = "ExpandedItemTemplate" +sig = "DataTemplate ExpandedItemTemplate { get; set; }" +returns = "DataTemplate" +summary = "Gets or sets the data template used for the item expansion." +file = "Controls\\VirtualizingWrapPanelControl\\GridDetailsView.xaml.cs" + +[[properties]] +parent = "GridDetailsView" +name = "ExpandedItem" +sig = "object ExpandedItem { get; }" +returns = "object" +summary = "Gets the currently expanded item. If no item is expanded null is returned." +file = "Controls\\VirtualizingWrapPanelControl\\GridDetailsView.xaml.cs" + +[[ctors]] +parent = "GridDetailsView" +sig = "GridDetailsView()" +file = "Controls\\VirtualizingWrapPanelControl\\GridDetailsView.xaml.cs" + +[[methods]] +parent = "GridDetailsView" +name = "GetContainerForItemOverride" +sig = "DependencyObject GetContainerForItemOverride()" +returns = "DependencyObject" +file = "Controls\\VirtualizingWrapPanelControl\\GridDetailsView.xaml.cs" + +[[classes]] +name = "GridView" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +base = "ListView" +summary = "Simple control that displays a gird of items. Depending on the orientation, the items are either stacked horizontally or vertically until the items are wrapped to the next row or column. The control is using virtualization to support large amount of items. In order to work properly all items must have the same size." +file = "Controls\\VirtualizingWrapPanelControl\\GridView.cs" + +[[properties]] +parent = "GridView" +name = "Orientation" +sig = "Orientation Orientation { get; set; }" +returns = "Orientation" +summary = "Gets or sets a value that specifies the orientation in which items are arranged. The default value is ." +file = "Controls\\VirtualizingWrapPanelControl\\GridView.cs" + +[[properties]] +parent = "GridView" +name = "SpacingMode" +sig = "SpacingMode SpacingMode { get; set; }" +returns = "SpacingMode" +summary = "Gets or sets the spacing mode used when arranging the items. The default value is ." +file = "Controls\\VirtualizingWrapPanelControl\\GridView.cs" + +[[properties]] +parent = "GridView" +name = "StretchItems" +sig = "bool StretchItems { get; set; }" +returns = "bool" +summary = "Gets or sets a value that specifies if the items get stretched to fill up remaining space. The default value is false." +file = "Controls\\VirtualizingWrapPanelControl\\GridView.cs" + +[[properties]] +parent = "GridView" +name = "IsWrappingKeyboardNavigationEnabled" +sig = "bool IsWrappingKeyboardNavigationEnabled { get; set; }" +returns = "bool" +summary = "Enables a improved wrapping keyboard navigation. The default value is false." +file = "Controls\\VirtualizingWrapPanelControl\\GridView.cs" + +[[ctors]] +parent = "GridView" +sig = "GridView()" +file = "Controls\\VirtualizingWrapPanelControl\\GridView.cs" + +[[interfaces]] +name = "IItemSizeProvider" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +summary = "Provides the size of items displayed in an VirtualizingPanel." +file = "Controls\\VirtualizingWrapPanelControl\\IItemSizeProvider.cs" + +[[methods]] +parent = "IItemSizeProvider" +name = "GetSizeForItem" +sig = "Size GetSizeForItem(object item)" +returns = "Size" +summary = "Gets the size for the specified item." +file = "Controls\\VirtualizingWrapPanelControl\\IItemSizeProvider.cs" + +[[interfaces]] +name = "IItemContainerInfo" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" + +[[properties]] +parent = "IItemContainerInfo" +name = "UIElement" +sig = "UIElement UIElement { get; }" +returns = "UIElement" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" + +[[properties]] +parent = "IItemContainerInfo" +name = "DesiredSize" +sig = "Size DesiredSize { get; }" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" + +[[properties]] +parent = "IItemContainerInfo" +name = "IsMeasureValid" +sig = "bool IsMeasureValid { get; }" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" + +[[properties]] +parent = "IItemContainerInfo" +name = "MaxSize" +sig = "Size MaxSize { get; }" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" + +[[properties]] +parent = "IItemContainerInfo" +name = "Item" +sig = "object Item { get; }" +returns = "object" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" + +[[methods]] +parent = "IItemContainerInfo" +name = "Measure" +sig = "Size Measure(Size availableSize)" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" + +[[methods]] +parent = "IItemContainerInfo" +name = "Arrange" +sig = "void Arrange(Rect rect)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" + +[[classes]] +name = "ItemContainerInfo" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +base = "IItemContainerInfo" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" + +[[properties]] +parent = "ItemContainerInfo" +name = "UIElement" +sig = "UIElement UIElement { get; }" +returns = "UIElement" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" + +[[properties]] +parent = "ItemContainerInfo" +name = "DesiredSize" +sig = "Size DesiredSize { get; }" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" + +[[properties]] +parent = "ItemContainerInfo" +name = "IsMeasureValid" +sig = "bool IsMeasureValid { get; }" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" + +[[properties]] +parent = "ItemContainerInfo" +name = "MaxSize" +sig = "Size MaxSize { get; }" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" + +[[properties]] +parent = "ItemContainerInfo" +name = "Item" +sig = "object Item { get; }" +returns = "object" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" + +[[methods]] +parent = "ItemContainerInfo" +name = "Measure" +sig = "Size Measure(Size availableSize)" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" + +[[methods]] +parent = "ItemContainerInfo" +name = "Arrange" +sig = "void Arrange(Rect rect)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" + +[[methods]] +parent = "ItemContainerInfo" +name = "For" +sig = "static IItemContainerInfo For(UIElement uiElement, object item)" +returns = "IItemContainerInfo" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" +static = true + +[[methods]] +parent = "ItemContainerInfo" +name = "Equals" +sig = "bool Equals(object obj)" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" + +[[methods]] +parent = "ItemContainerInfo" +name = "GetHashCode" +sig = "int GetHashCode()" +returns = "int" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerInfo.cs" + +[[classes]] +name = "ItemContainerManagerItemsChangedEventArgs" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[properties]] +parent = "ItemContainerManagerItemsChangedEventArgs" +name = "Action" +sig = "NotifyCollectionChangedAction Action { get; }" +returns = "NotifyCollectionChangedAction" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[properties]] +parent = "ItemContainerManagerItemsChangedEventArgs" +name = "RemovedContainers" +sig = "IReadOnlyCollection RemovedContainers { get; }" +returns = "IReadOnlyCollection" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[ctors]] +parent = "ItemContainerManagerItemsChangedEventArgs" +sig = "ItemContainerManagerItemsChangedEventArgs(NotifyCollectionChangedAction action, IReadOnlyCollection removedContainers)" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[interfaces]] +name = "IItemContainerManager" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[properties]] +parent = "IItemContainerManager" +name = "IsRecycling" +sig = "bool IsRecycling { get; set; }" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[properties]] +parent = "IItemContainerManager" +name = "Items" +sig = "ReadOnlyCollection Items { get; }" +returns = "ReadOnlyCollection" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[properties]] +parent = "IItemContainerManager" +name = "RealizedContainers" +sig = "IEnumerable RealizedContainers { get; }" +returns = "IEnumerable" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[properties]] +parent = "IItemContainerManager" +name = "CachedContainers" +sig = "IEnumerable CachedContainers { get; }" +returns = "IEnumerable" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[methods]] +parent = "IItemContainerManager" +name = "Realize" +sig = "IItemContainerInfo Realize(int itemIndex, out bool isNewlyRealized, out bool isNewContainer)" +returns = "IItemContainerInfo" +summary = "Realizes the specified item. If the item is already realized, nothing happens." +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[methods]] +parent = "IItemContainerManager" +name = "Virtualize" +sig = "bool Virtualize(IItemContainerInfo containerInfo)" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[methods]] +parent = "IItemContainerManager" +name = "FindItemIndexOfContainer" +sig = "int FindItemIndexOfContainer(IItemContainerInfo containerInfo)" +returns = "int" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[classes]] +name = "ItemContainerManager" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +base = "IItemContainerManager" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[properties]] +parent = "ItemContainerManager" +name = "IsRecycling" +sig = "bool IsRecycling { get; set; }" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[properties]] +parent = "ItemContainerManager" +name = "Items" +sig = "ReadOnlyCollection Items { get; }" +returns = "ReadOnlyCollection" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[properties]] +parent = "ItemContainerManager" +name = "RealizedContainers" +sig = "IEnumerable RealizedContainers { get; }" +returns = "IEnumerable" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[properties]] +parent = "ItemContainerManager" +name = "CachedContainers" +sig = "IEnumerable CachedContainers { get; }" +returns = "IEnumerable" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[ctors]] +parent = "ItemContainerManager" +sig = "ItemContainerManager(ItemContainerGenerator itemContainerGenerator)" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[methods]] +parent = "ItemContainerManager" +name = "Realize" +sig = "IItemContainerInfo Realize(int itemIndex, out bool isNewlyRealized, out bool isNewContainer)" +returns = "IItemContainerInfo" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[methods]] +parent = "ItemContainerManager" +name = "Virtualize" +sig = "bool Virtualize(IItemContainerInfo containerInfo)" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[methods]] +parent = "ItemContainerManager" +name = "FindItemIndexOfContainer" +sig = "int FindItemIndexOfContainer(IItemContainerInfo containerInfo)" +returns = "int" +file = "Controls\\VirtualizingWrapPanelControl\\ItemContainerManager.cs" + +[[classes]] +name = "ItemRange" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +file = "Controls\\VirtualizingWrapPanelControl\\ItemRange.cs" + +[[properties]] +parent = "ItemRange" +name = "StartIndex" +sig = "int StartIndex { get; }" +returns = "int" +file = "Controls\\VirtualizingWrapPanelControl\\ItemRange.cs" + +[[properties]] +parent = "ItemRange" +name = "EndIndex" +sig = "int EndIndex { get; }" +returns = "int" +file = "Controls\\VirtualizingWrapPanelControl\\ItemRange.cs" + +[[ctors]] +parent = "ItemRange" +sig = "ItemRange(int startIndex, int endIndex)" +file = "Controls\\VirtualizingWrapPanelControl\\ItemRange.cs" + +[[methods]] +parent = "ItemRange" +name = "Contains" +sig = "bool Contains(int itemIndex)" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\ItemRange.cs" + +[[enums]] +name = "ScrollDirection" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +file = "Controls\\VirtualizingWrapPanelControl\\ScrollDirection.cs" + +[[enums]] +name = "SpacingMode" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +summary = "Specifies how remaining space is distributed." +file = "Controls\\VirtualizingWrapPanelControl\\SpacingMode.cs" + +[[classes]] +name = "VirtualizingItemsControl" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +base = "ItemsControl" +summary = "A ItemsControl supporting virtualization." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingItemsControl.cs" + +[[ctors]] +parent = "VirtualizingItemsControl" +sig = "VirtualizingItemsControl()" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingItemsControl.cs" + +[[classes]] +name = "VirtualizingPanelBase" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +base = "VirtualizingPanel, IScrollInfo" +summary = "Base class for panels which are supporting virtualization." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "ScrollOwner" +sig = "ScrollViewer ScrollOwner { get; set; }" +returns = "ScrollViewer" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "CanVerticallyScroll" +sig = "bool CanVerticallyScroll { get; set; }" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "CanHorizontallyScroll" +sig = "bool CanHorizontallyScroll { get; set; }" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "ScrollLineDelta" +sig = "double ScrollLineDelta { get; set; }" +returns = "double" +summary = "Scroll line delta for pixel based scrolling. The default value is 16 dp." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "MouseWheelDelta" +sig = "double MouseWheelDelta { get; set; }" +returns = "double" +summary = "Mouse wheel delta for pixel based scrolling. The default value is 48 dp." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "ScrollLineDeltaItem" +sig = "int ScrollLineDeltaItem { get; set; }" +returns = "int" +summary = "Scroll line delta for item based scrolling. The default value is 1 item." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "MouseWheelDeltaItem" +sig = "int MouseWheelDeltaItem { get; set; }" +returns = "int" +summary = "Mouse wheel delta for item based scrolling. The default value is 3 items." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "ExtentWidth" +sig = "double ExtentWidth { get; }" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "ExtentHeight" +sig = "double ExtentHeight { get; }" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "HorizontalOffset" +sig = "double HorizontalOffset { get; }" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "VerticalOffset" +sig = "double VerticalOffset { get; }" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "ViewportWidth" +sig = "double ViewportWidth { get; }" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "ViewportHeight" +sig = "double ViewportHeight { get; }" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "ScrollUnit" +sig = "ScrollUnit ScrollUnit { get; }" +returns = "ScrollUnit" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "MouseWheelScrollDirection" +sig = "ScrollDirection MouseWheelScrollDirection { get; set; }" +returns = "ScrollDirection" +summary = "The direction in which the panel scrolls when user turns the mouse wheel." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "IsVirtualizing" +sig = "bool IsVirtualizing { get; }" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "VirtualizationMode" +sig = "VirtualizationMode VirtualizationMode { get; }" +returns = "VirtualizationMode" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "IsRecycling" +sig = "bool IsRecycling { get; }" +returns = "bool" +summary = "Returns true if the panel is in VirtualizationMode.Recycling, otherwise false." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "CacheLength" +sig = "VirtualizationCacheLength CacheLength { get; }" +returns = "VirtualizationCacheLength" +summary = "The cache length before and after the viewport." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "CacheLengthUnit" +sig = "VirtualizationCacheLengthUnit CacheLengthUnit { get; }" +returns = "VirtualizationCacheLengthUnit" +summary = "The Unit of the cache length. Can be Pixel, Item or Page. When the ItemsOwner is a group item it can only be pixel or item." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "ItemsControl" +sig = "ItemsControl ItemsControl { get; }" +returns = "ItemsControl" +summary = "The ItemsControl (e.g. ListView)." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "ItemsOwner" +sig = "DependencyObject ItemsOwner { get; }" +returns = "DependencyObject" +summary = "The ItemsControl (e.g. ListView) or if the ItemsControl is grouping a GroupItem." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "Items" +sig = "ReadOnlyCollection Items { get; }" +returns = "ReadOnlyCollection" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "ItemContainerGenerator" +sig = "ItemContainerGenerator ItemContainerGenerator { get; }" +returns = "ItemContainerGenerator" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[properties]] +parent = "VirtualizingPanelBase" +name = "BaseModel" +sig = "VirtualizingPanelModelBase BaseModel { get; }" +returns = "VirtualizingPanelModelBase" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[methods]] +parent = "VirtualizingPanelBase" +name = "MakeVisible" +sig = "Rect MakeVisible(Visual visual, Rect rectangle)" +returns = "Rect" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[methods]] +parent = "VirtualizingPanelBase" +name = "LineUp" +sig = "void LineUp()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[methods]] +parent = "VirtualizingPanelBase" +name = "LineDown" +sig = "void LineDown()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[methods]] +parent = "VirtualizingPanelBase" +name = "LineLeft" +sig = "void LineLeft()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[methods]] +parent = "VirtualizingPanelBase" +name = "LineRight" +sig = "void LineRight()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[methods]] +parent = "VirtualizingPanelBase" +name = "MouseWheelUp" +sig = "void MouseWheelUp()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[methods]] +parent = "VirtualizingPanelBase" +name = "MouseWheelDown" +sig = "void MouseWheelDown()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[methods]] +parent = "VirtualizingPanelBase" +name = "MouseWheelLeft" +sig = "void MouseWheelLeft()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[methods]] +parent = "VirtualizingPanelBase" +name = "MouseWheelRight" +sig = "void MouseWheelRight()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[methods]] +parent = "VirtualizingPanelBase" +name = "PageUp" +sig = "void PageUp()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[methods]] +parent = "VirtualizingPanelBase" +name = "PageDown" +sig = "void PageDown()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[methods]] +parent = "VirtualizingPanelBase" +name = "PageLeft" +sig = "void PageLeft()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[methods]] +parent = "VirtualizingPanelBase" +name = "PageRight" +sig = "void PageRight()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[methods]] +parent = "VirtualizingPanelBase" +name = "SetHorizontalOffset" +sig = "void SetHorizontalOffset(double offset)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[methods]] +parent = "VirtualizingPanelBase" +name = "SetVerticalOffset" +sig = "void SetVerticalOffset(double offset)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[methods]] +parent = "VirtualizingPanelBase" +name = "ShouldIgnoreMeasure" +sig = "bool ShouldIgnoreMeasure()" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBase.cs" + +[[classes]] +name = "VirtualizingPanelBaseV1" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +base = "VirtualizingPanel, IScrollInfo" +summary = "Base class for panels which are supporting virtualization." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "ScrollOwner" +sig = "ScrollViewer ScrollOwner { get; set; }" +returns = "ScrollViewer" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "CanVerticallyScroll" +sig = "bool CanVerticallyScroll { get; set; }" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "CanHorizontallyScroll" +sig = "bool CanHorizontallyScroll { get; set; }" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "ScrollLineDelta" +sig = "double ScrollLineDelta { get; set; }" +returns = "double" +summary = "Scroll line delta for pixel based scrolling. The default value is 16 dp." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "MouseWheelDelta" +sig = "double MouseWheelDelta { get; set; }" +returns = "double" +summary = "Mouse wheel delta for pixel based scrolling. The default value is 48 dp." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "ScrollLineDeltaItem" +sig = "double ScrollLineDeltaItem { get; set; }" +returns = "double" +summary = "Scroll line delta for item based scrolling. The default value is 1 item." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "MouseWheelDeltaItem" +sig = "int MouseWheelDeltaItem { get; set; }" +returns = "int" +summary = "Mouse wheel delta for item based scrolling. The default value is 3 items." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "ExtentWidth" +sig = "double ExtentWidth { get; }" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "ExtentHeight" +sig = "double ExtentHeight { get; }" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "HorizontalOffset" +sig = "double HorizontalOffset { get; }" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "VerticalOffset" +sig = "double VerticalOffset { get; }" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "ViewportWidth" +sig = "double ViewportWidth { get; }" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "ViewportHeight" +sig = "double ViewportHeight { get; }" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "CanHierarchicallyScrollAndVirtualizeCore" +sig = "bool CanHierarchicallyScrollAndVirtualizeCore { get; }" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "ScrollUnit" +sig = "ScrollUnit ScrollUnit { get; }" +returns = "ScrollUnit" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "MouseWheelScrollDirection" +sig = "ScrollDirection MouseWheelScrollDirection { get; set; }" +returns = "ScrollDirection" +summary = "The direction in which the panel scrolls when user turns the mouse wheel." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "IsVirtualizing" +sig = "bool IsVirtualizing { get; }" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "VirtualizationMode" +sig = "VirtualizationMode VirtualizationMode { get; }" +returns = "VirtualizationMode" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "IsRecycling" +sig = "bool IsRecycling { get; }" +returns = "bool" +summary = "Returns true if the panel is in VirtualizationMode.Recycling, otherwise false." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "CacheLength" +sig = "VirtualizationCacheLength CacheLength { get; }" +returns = "VirtualizationCacheLength" +summary = "The cache length before and after the viewport." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "CacheLengthUnit" +sig = "VirtualizationCacheLengthUnit CacheLengthUnit { get; }" +returns = "VirtualizationCacheLengthUnit" +summary = "The Unit of the cache length. Can be Pixel, Item or Page. When the ItemsOwner is a group item it can only be pixel or item." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "ItemsControl" +sig = "ItemsControl ItemsControl { get; }" +returns = "ItemsControl" +summary = "The ItemsControl (e.g. ListView)." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "ItemsOwner" +sig = "DependencyObject ItemsOwner { get; }" +returns = "DependencyObject" +summary = "The ItemsControl (e.g. ListView) or if the ItemsControl is grouping a GroupItem." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "Items" +sig = "ReadOnlyCollection Items { get; }" +returns = "ReadOnlyCollection" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "ItemContainerGenerator" +sig = "IRecyclingItemContainerGenerator ItemContainerGenerator { get; }" +returns = "IRecyclingItemContainerGenerator" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "Extent" +sig = "Size Extent { get; }" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "ViewportSize" +sig = "Size ViewportSize { get; }" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "Offset" +sig = "Point Offset { get; }" +returns = "Point" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[properties]] +parent = "VirtualizingPanelBaseV1" +name = "ItemRange" +sig = "ItemRange ItemRange { get; set; }" +returns = "ItemRange" +summary = "The range of items that a realized in viewport or cache." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "MakeVisible" +sig = "Rect MakeVisible(Visual visual, Rect rectangle)" +returns = "Rect" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "SetVerticalOffset" +sig = "void SetVerticalOffset(double offset)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "SetHorizontalOffset" +sig = "void SetHorizontalOffset(double offset)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "LineUp" +sig = "void LineUp()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "LineDown" +sig = "void LineDown()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "LineLeft" +sig = "void LineLeft()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "LineRight" +sig = "void LineRight()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "MouseWheelUp" +sig = "void MouseWheelUp()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "MouseWheelDown" +sig = "void MouseWheelDown()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "MouseWheelLeft" +sig = "void MouseWheelLeft()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "MouseWheelRight" +sig = "void MouseWheelRight()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "PageUp" +sig = "void PageUp()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "PageDown" +sig = "void PageDown()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "PageLeft" +sig = "void PageLeft()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "PageRight" +sig = "void PageRight()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "CalculateExtent" +sig = "Size CalculateExtent(Size availableSize)" +returns = "Size" +summary = "Calculates the extent that would be needed to show all items." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "UpdateItemRange" +sig = "ItemRange UpdateItemRange()" +returns = "ItemRange" +summary = "Calculates the item range that is visible in the viewport or cached." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "GetLineUpScrollAmount" +sig = "double GetLineUpScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "GetLineDownScrollAmount" +sig = "double GetLineDownScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "GetLineLeftScrollAmount" +sig = "double GetLineLeftScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "GetLineRightScrollAmount" +sig = "double GetLineRightScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "GetMouseWheelUpScrollAmount" +sig = "double GetMouseWheelUpScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "GetMouseWheelDownScrollAmount" +sig = "double GetMouseWheelDownScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "GetMouseWheelLeftScrollAmount" +sig = "double GetMouseWheelLeftScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "GetMouseWheelRightScrollAmount" +sig = "double GetMouseWheelRightScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "GetPageUpScrollAmount" +sig = "double GetPageUpScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "GetPageDownScrollAmount" +sig = "double GetPageDownScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "GetPageLeftScrollAmount" +sig = "double GetPageLeftScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "GetPageRightScrollAmount" +sig = "double GetPageRightScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "UpdateScrollInfo" +sig = "void UpdateScrollInfo(Size availableSize, Size extent)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "GetGeneratorPositionFromChildIndex" +sig = "GeneratorPosition GetGeneratorPositionFromChildIndex(int childIndex)" +returns = "GeneratorPosition" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "RealizeItems" +sig = "void RealizeItems()" +returns = "void" +summary = "Realizes visible and cached items." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "VirtualizeItems" +sig = "void VirtualizeItems()" +returns = "void" +summary = "Virtualizes (cleanups) no longer visible or cached items." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "OnItemsChanged" +sig = "void OnItemsChanged(object sender, ItemsChangedEventArgs args)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "MeasureOverride" +sig = "Size MeasureOverride(Size availableSize)" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "GetItemIndexFromChildIndex" +sig = "int GetItemIndexFromChildIndex(int childIndex)" +returns = "int" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "ScrollVertical" +sig = "void ScrollVertical(double amount)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[methods]] +parent = "VirtualizingPanelBaseV1" +name = "ScrollHorizontal" +sig = "void ScrollHorizontal(double amount)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelBaseV1.cs" + +[[classes]] +name = "VirtualizingPanelModelBase" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[properties]] +parent = "VirtualizingPanelModelBase" +name = "Extent" +sig = "Size Extent { get; set; }" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[properties]] +parent = "VirtualizingPanelModelBase" +name = "ViewportSize" +sig = "Size ViewportSize { get; set; }" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[properties]] +parent = "VirtualizingPanelModelBase" +name = "ScrollOffset" +sig = "Point ScrollOffset { get; set; }" +returns = "Point" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[properties]] +parent = "VirtualizingPanelModelBase" +name = "ScrollUnit" +sig = "ScrollUnit ScrollUnit { get; set; }" +returns = "ScrollUnit" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[properties]] +parent = "VirtualizingPanelModelBase" +name = "CacheLength" +sig = "VirtualizationCacheLength CacheLength { get; set; }" +returns = "VirtualizationCacheLength" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[properties]] +parent = "VirtualizingPanelModelBase" +name = "CacheLengthUnit" +sig = "VirtualizationCacheLengthUnit CacheLengthUnit { get; set; }" +returns = "VirtualizationCacheLengthUnit" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[properties]] +parent = "VirtualizingPanelModelBase" +name = "ScrollLineDelta" +sig = "double ScrollLineDelta { get; set; }" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[properties]] +parent = "VirtualizingPanelModelBase" +name = "MouseWheelDelta" +sig = "double MouseWheelDelta { get; set; }" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[properties]] +parent = "VirtualizingPanelModelBase" +name = "ScrollLineDeltaItem" +sig = "int ScrollLineDeltaItem { get; set; }" +returns = "int" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[properties]] +parent = "VirtualizingPanelModelBase" +name = "MouseWheelDeltaItem" +sig = "int MouseWheelDeltaItem { get; set; }" +returns = "int" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[properties]] +parent = "VirtualizingPanelModelBase" +name = "MouseWheelScrollDirection" +sig = "ScrollDirection MouseWheelScrollDirection { get; set; }" +returns = "ScrollDirection" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "SetVerticalOffset" +sig = "void SetVerticalOffset(double offset)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "SetHorizontalOffset" +sig = "void SetHorizontalOffset(double offset)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "LineUp" +sig = "void LineUp()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "LineDown" +sig = "void LineDown()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "LineLeft" +sig = "void LineLeft()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "LineRight" +sig = "void LineRight()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "MouseWheelUp" +sig = "void MouseWheelUp()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "MouseWheelDown" +sig = "void MouseWheelDown()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "MouseWheelLeft" +sig = "void MouseWheelLeft()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "MouseWheelRight" +sig = "void MouseWheelRight()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "PageUp" +sig = "void PageUp()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "PageDown" +sig = "void PageDown()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "PageLeft" +sig = "void PageLeft()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "PageRight" +sig = "void PageRight()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "GetLineUpScrollAmount" +sig = "double GetLineUpScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "GetLineDownScrollAmount" +sig = "double GetLineDownScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "GetLineLeftScrollAmount" +sig = "double GetLineLeftScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "GetLineRightScrollAmount" +sig = "double GetLineRightScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "GetMouseWheelUpScrollAmount" +sig = "double GetMouseWheelUpScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "GetMouseWheelDownScrollAmount" +sig = "double GetMouseWheelDownScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "GetMouseWheelLeftScrollAmount" +sig = "double GetMouseWheelLeftScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "GetMouseWheelRightScrollAmount" +sig = "double GetMouseWheelRightScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "GetPageUpScrollAmount" +sig = "double GetPageUpScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "GetPageDownScrollAmount" +sig = "double GetPageDownScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "GetPageLeftScrollAmount" +sig = "double GetPageLeftScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "GetPageRightScrollAmount" +sig = "double GetPageRightScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "InvalidateScrollInfo" +sig = "void InvalidateScrollInfo()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[methods]] +parent = "VirtualizingPanelModelBase" +name = "InvalidateMeasure" +sig = "void InvalidateMeasure()" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingPanelModelBase.cs" + +[[classes]] +name = "VirtualizingWrapPanel" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +base = "VirtualizingPanelBase" +summary = "A implementation of a wrap panel that supports virtualization and can be used in horizontal and vertical orientation. https://github.com/sbaeumlisberger/VirtualizingWrapPanel" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanel.cs" + +[[properties]] +parent = "VirtualizingWrapPanel" +name = "Orientation" +sig = "Orientation Orientation { get; set; }" +returns = "Orientation" +summary = "Gets or sets a value that specifies the orientation in which items are arranged. The default value is ." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanel.cs" + +[[properties]] +parent = "VirtualizingWrapPanel" +name = "ItemSize" +sig = "Size ItemSize { get; set; }" +returns = "Size" +summary = "Gets or sets a value that specifies the size of the items. The default value is . If the value is the item size is determined by measuring the first realized item." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanel.cs" + +[[properties]] +parent = "VirtualizingWrapPanel" +name = "ItemSizeProvider" +sig = "IItemSizeProvider ItemSizeProvider { get; set; }" +returns = "IItemSizeProvider" +summary = "Specifies an instance of which provides the size of the items. In order to allow different sized items, also enable the property." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanel.cs" + +[[properties]] +parent = "VirtualizingWrapPanel" +name = "AllowDifferentSizedItems" +sig = "bool AllowDifferentSizedItems { get; set; }" +returns = "bool" +summary = "Specifies whether items can have different sizes. The default value is false. If this property is enabled, it is strongly recommended to also set the property. Otherwise, the position of the items is not always guaranteed to be correct." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanel.cs" + +[[properties]] +parent = "VirtualizingWrapPanel" +name = "SpacingMode" +sig = "SpacingMode SpacingMode { get; set; }" +returns = "SpacingMode" +summary = "Gets or sets the spacing mode used when arranging the items. The default value is ." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanel.cs" + +[[properties]] +parent = "VirtualizingWrapPanel" +name = "StretchItems" +sig = "bool StretchItems { get; set; }" +returns = "bool" +summary = "Gets or sets a value that specifies if the items get stretched to fill up remaining space. The default value is false." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanel.cs" + +[[properties]] +parent = "VirtualizingWrapPanel" +name = "HorizontalGroupOffset" +sig = "double HorizontalGroupOffset { get; set; }" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanel.cs" + +[[properties]] +parent = "VirtualizingWrapPanel" +name = "CanHierarchicallyScrollAndVirtualizeCore" +sig = "bool CanHierarchicallyScrollAndVirtualizeCore { get; }" +returns = "bool" +summary = "Gets value that indicates whether the can virtualize items that are grouped or organized in a hierarchy." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanel.cs" + +[[properties]] +parent = "VirtualizingWrapPanel" +name = "HasLogicalOrientation" +sig = "bool HasLogicalOrientation { get; }" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanel.cs" + +[[properties]] +parent = "VirtualizingWrapPanel" +name = "LogicalOrientation" +sig = "Orientation LogicalOrientation { get; }" +returns = "Orientation" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanel.cs" + +[[properties]] +parent = "VirtualizingWrapPanel" +name = "BaseModel" +sig = "VirtualizingPanelModelBase BaseModel { get; }" +returns = "VirtualizingPanelModelBase" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanel.cs" + +[[ctors]] +parent = "VirtualizingWrapPanel" +sig = "VirtualizingWrapPanel()" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanel.cs" + +[[methods]] +parent = "VirtualizingWrapPanel" +name = "MeasureOverride" +sig = "Size MeasureOverride(Size availableSize)" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanel.cs" + +[[methods]] +parent = "VirtualizingWrapPanel" +name = "ArrangeOverride" +sig = "Size ArrangeOverride(Size finalSize)" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanel.cs" + +[[methods]] +parent = "VirtualizingWrapPanel" +name = "BringIndexIntoView" +sig = "void BringIndexIntoView(int index)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanel.cs" + +[[classes]] +name = "VirtualizingWrapPanelModel" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +base = "VirtualizingPanelModelBase" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[properties]] +parent = "VirtualizingWrapPanelModel" +name = "Orientation" +sig = "Orientation Orientation { get; set; }" +returns = "Orientation" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[properties]] +parent = "VirtualizingWrapPanelModel" +name = "FixedItemSize" +sig = "Size FixedItemSize { get; set; }" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[properties]] +parent = "VirtualizingWrapPanelModel" +name = "ItemSizeProvider" +sig = "IItemSizeProvider ItemSizeProvider { get; set; }" +returns = "IItemSizeProvider" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[properties]] +parent = "VirtualizingWrapPanelModel" +name = "AllowDifferentSizedItems" +sig = "bool AllowDifferentSizedItems { get; set; }" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[properties]] +parent = "VirtualizingWrapPanelModel" +name = "StretchItems" +sig = "bool StretchItems { get; set; }" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[properties]] +parent = "VirtualizingWrapPanelModel" +name = "SpacingMode" +sig = "SpacingMode SpacingMode { get; set; }" +returns = "SpacingMode" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[ctors]] +parent = "VirtualizingWrapPanelModel" +sig = "VirtualizingWrapPanelModel(IItemContainerManager itemContainerManager, IChildrenCollection childrenCollection)" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "OnMeasure" +sig = "Size OnMeasure(Size availableSize)" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "OnMeasure" +sig = "Size OnMeasure(Size availableSize, Size viewportSize, Point scrollOffset)" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "OnArrange" +sig = "Size OnArrange(Size finalSize, bool hierarchical)" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "GetAverageItemSize" +sig = "Size GetAverageItemSize()" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "BringIndexIntoView" +sig = "void BringIndexIntoView(int itemIndex)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "GetLineUpScrollAmount" +sig = "double GetLineUpScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "GetLineDownScrollAmount" +sig = "double GetLineDownScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "GetLineLeftScrollAmount" +sig = "double GetLineLeftScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "GetLineRightScrollAmount" +sig = "double GetLineRightScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "GetMouseWheelUpScrollAmount" +sig = "double GetMouseWheelUpScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "GetMouseWheelDownScrollAmount" +sig = "double GetMouseWheelDownScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "GetMouseWheelLeftScrollAmount" +sig = "double GetMouseWheelLeftScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "GetMouseWheelRightScrollAmount" +sig = "double GetMouseWheelRightScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "GetPageUpScrollAmount" +sig = "double GetPageUpScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "GetPageDownScrollAmount" +sig = "double GetPageDownScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "GetPageLeftScrollAmount" +sig = "double GetPageLeftScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "GetPageRightScrollAmount" +sig = "double GetPageRightScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "GetX" +sig = "double GetX(Point point)" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "GetY" +sig = "double GetY(Point point)" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "GetWidth" +sig = "double GetWidth(Size size)" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "GetHeight" +sig = "double GetHeight(Size size)" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "CreatePoint" +sig = "Point CreatePoint(double x, double y)" +returns = "Point" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "CreateSize" +sig = "Size CreateSize(double width, double height)" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[methods]] +parent = "VirtualizingWrapPanelModel" +name = "CreateRect" +sig = "Rect CreateRect(double x, double y, double width, double height)" +returns = "Rect" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelModel.cs" + +[[classes]] +name = "VirtualizingWrapPanelV1" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +base = "VirtualizingPanelBaseV1" +summary = "A implementation of a wrap panel that supports virtualization and can be used in horizontal and vertical orientation. In order to work properly all items must have the same size." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[properties]] +parent = "VirtualizingWrapPanelV1" +name = "SpacingMode" +sig = "SpacingMode SpacingMode { get; set; }" +returns = "SpacingMode" +summary = "Gets or sets the spacing mode used when arranging the items. The default value is ." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[properties]] +parent = "VirtualizingWrapPanelV1" +name = "Orientation" +sig = "Orientation Orientation { get; set; }" +returns = "Orientation" +summary = "Gets or sets a value that specifies the orientation in which items are arranged. The default value is ." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[properties]] +parent = "VirtualizingWrapPanelV1" +name = "ItemSize" +sig = "Size ItemSize { get; set; }" +returns = "Size" +summary = "Gets or sets a value that specifies the size of the items. The default value is . If the value is the size of the items gots measured by the first realized item." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[properties]] +parent = "VirtualizingWrapPanelV1" +name = "StretchItems" +sig = "bool StretchItems { get; set; }" +returns = "bool" +summary = "Gets or sets a value that specifies if the items get stretched to fill up remaining space. The default value is false." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "MeasureOverride" +sig = "Size MeasureOverride(Size availableSize)" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "CalculateExtent" +sig = "Size CalculateExtent(Size availableSize)" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "ArrangeOverride" +sig = "Size ArrangeOverride(Size finalSize)" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "UpdateItemRange" +sig = "ItemRange UpdateItemRange()" +returns = "ItemRange" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "BringIndexIntoView" +sig = "void BringIndexIntoView(int index)" +returns = "void" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "GetLineUpScrollAmount" +sig = "double GetLineUpScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "GetLineDownScrollAmount" +sig = "double GetLineDownScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "GetLineLeftScrollAmount" +sig = "double GetLineLeftScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "GetLineRightScrollAmount" +sig = "double GetLineRightScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "GetMouseWheelUpScrollAmount" +sig = "double GetMouseWheelUpScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "GetMouseWheelDownScrollAmount" +sig = "double GetMouseWheelDownScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "GetMouseWheelLeftScrollAmount" +sig = "double GetMouseWheelLeftScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "GetMouseWheelRightScrollAmount" +sig = "double GetMouseWheelRightScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "GetPageUpScrollAmount" +sig = "double GetPageUpScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "GetPageDownScrollAmount" +sig = "double GetPageDownScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" + +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "GetPageLeftScrollAmount" +sig = "double GetPageLeftScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" -[[classes]] -name = "DependencyObjectExtensions" -ns = "FEx.WPFx.Extensions" -file = "Extensions\\DependencyObjectExtensions.cs" -static = true +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "GetPageRightScrollAmount" +sig = "double GetPageRightScrollAmount()" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" -[[extensions]] -name = "InvokeOnDispatcherContext" -sig = "void InvokeOnDispatcherContext(this DependencyObject sender, - Action action, - DispatcherPriority priority = DispatcherPriority.Send)" +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "CalculateSpacing" +sig = "void CalculateSpacing(Size finalSize, out double innerSpacing, out double outerSpacing)" returns = "void" -file = "Extensions\\DependencyObjectExtensions.cs" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" -[[extensions]] -name = "DoUpdateSource" -sig = "void DoUpdateSource(this DependencyProperty property, object source)" -returns = "void" -file = "Extensions\\DependencyObjectExtensions.cs" +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "CalculateChildArrangeSize" +sig = "Size CalculateChildArrangeSize(Size finalSize)" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" -[[classes]] -name = "DependencyPropertyExtensions" -ns = "FEx.WPFx.Extensions" -file = "Extensions\\DependencyPropertyExtensions.cs" -static = true +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "GetX" +sig = "double GetX(Point point)" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" -[[classes]] -name = "IconExtensions" -ns = "FEx.WPFx.Extensions" -summary = "Icon extensions class." -file = "Extensions\\IconExtensions.cs" -static = true +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "GetY" +sig = "double GetY(Point point)" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" -[[extensions]] -name = "GetIconCharacter" -sig = "char GetIconCharacter(this Enum value)" -returns = "char" -summary = "Gets the icon character." -file = "Extensions\\IconExtensions.cs" +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "GetWidth" +sig = "double GetWidth(Size size)" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" -[[extensions]] -name = "GetAltText" -sig = "string GetAltText(this Enum value)" -returns = "string" -summary = "Gets the alt text." -file = "Extensions\\IconExtensions.cs" +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "GetHeight" +sig = "double GetHeight(Size size)" +returns = "double" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" -[[classes]] -name = "TreeViewBuilderExtensions" -ns = "FEx.WPFx.Extensions" -file = "Extensions\\TreeViewBuilderExtensions.cs" -static = true +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "CreateSize" +sig = "Size CreateSize(double width, double height)" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" -[[extensions]] -name = "AddChildNode" -sig = "void AddChildNode(this ITreeViewBuilder builder, string rootNodeName, List nodePath)" -returns = "void" -file = "Extensions\\TreeViewBuilderExtensions.cs" +[[methods]] +parent = "VirtualizingWrapPanelV1" +name = "CreateRect" +sig = "Rect CreateRect(double x, double y, double width, double height)" +returns = "Rect" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" -[[extensions]] -name = "AddChildNode" -sig = "void AddChildNode(this ITreeViewBuilder builder, - string rootNodeName, - List nodePath, - string name)" -returns = "void" -file = "Extensions\\TreeViewBuilderExtensions.cs" +[[properties]] +parent = "VirtualizingWrapPanelV1" +name = "SpacingEnabled" +sig = "bool SpacingEnabled { get; set; }" +returns = "bool" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" -[[extensions]] -name = "AddChildNode" -sig = "void AddChildNode(this ITreeViewBuilder builder, - string rootNodeName, - List nodePath, - string name, - bool unique)" -returns = "void" -file = "Extensions\\TreeViewBuilderExtensions.cs" +[[properties]] +parent = "VirtualizingWrapPanelV1" +name = "IsSpacingEnabled" +sig = "bool IsSpacingEnabled { get; set; }" +returns = "bool" +summary = "Gets or sets a value that specifies whether the items are distributed evenly across the width (horizontal orientation) or height (vertical orientation). The default value is true." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" -[[extensions]] -name = "AddChildNode" -sig = "void AddChildNode(this ITreeViewBuilder builder, - string rootNodeName, - List nodePath, - string name, - bool unique, - string iconPath)" -returns = "void" -file = "Extensions\\TreeViewBuilderExtensions.cs" +[[properties]] +parent = "VirtualizingWrapPanelV1" +name = "ChildrenSize" +sig = "Size ChildrenSize { get; set; }" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelV1.cs" -[[extensions]] -name = "AddChildNode" -sig = "void AddChildNode(this ITreeViewBuilder builder, - string rootNodeName, - List nodePath, - string name, - bool unique, - string iconPath, - bool isIconAttachedToFile)" -returns = "void" -file = "Extensions\\TreeViewBuilderExtensions.cs" +[[classes]] +name = "VirtualizingWrapPanelWithItemExpansion" +ns = "FEx.WPFx.Controls.VirtualizingWrapPanelControl" +base = "VirtualizingWrapPanelV1" +summary = "A implementation of a wrap panel that supports virtualization and can be used in horizontal and vertical orientation. In addition the panel allows to expand one specific item. In order to work properly all items must have the same size." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelWithItemExpansion.cs" -[[extensions]] -name = "AddChildNode" -sig = "void AddChildNode(this ITreeViewBuilder builder, string rootNodeName, string nodePath)" -returns = "void" -file = "Extensions\\TreeViewBuilderExtensions.cs" +[[properties]] +parent = "VirtualizingWrapPanelWithItemExpansion" +name = "ExpandedItemTemplate" +sig = "DataTemplate ExpandedItemTemplate { get; set; }" +returns = "DataTemplate" +summary = "Gets or sets the data template used for the item expansion." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelWithItemExpansion.cs" -[[extensions]] -name = "AddChildNode" -sig = "void AddChildNode(this ITreeViewBuilder builder, string rootNodeName, string nodePath, string name)" -returns = "void" -file = "Extensions\\TreeViewBuilderExtensions.cs" +[[properties]] +parent = "VirtualizingWrapPanelWithItemExpansion" +name = "ExpandedItem" +sig = "object ExpandedItem { get; set; }" +returns = "object" +summary = "Gets or set the expanded item. The default value is null." +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelWithItemExpansion.cs" -[[extensions]] -name = "AddChildNode" -sig = "void AddChildNode(this ITreeViewBuilder builder, - string rootNodeName, - string nodePath, - string name, - char pathSeparator)" +[[methods]] +parent = "VirtualizingWrapPanelWithItemExpansion" +name = "CalculateExtent" +sig = "Size CalculateExtent(Size availableSize)" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelWithItemExpansion.cs" + +[[methods]] +parent = "VirtualizingWrapPanelWithItemExpansion" +name = "ArrangeOverride" +sig = "Size ArrangeOverride(Size finalSize)" +returns = "Size" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelWithItemExpansion.cs" + +[[methods]] +parent = "VirtualizingWrapPanelWithItemExpansion" +name = "RealizeItems" +sig = "void RealizeItems()" returns = "void" -file = "Extensions\\TreeViewBuilderExtensions.cs" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelWithItemExpansion.cs" -[[extensions]] -name = "AddChildNode" -sig = "void AddChildNode(this ITreeViewBuilder builder, - string rootNodeName, - string nodePath, - string name, - char pathSeparator, - bool unique)" +[[methods]] +parent = "VirtualizingWrapPanelWithItemExpansion" +name = "OnClearChildren" +sig = "void OnClearChildren()" returns = "void" -file = "Extensions\\TreeViewBuilderExtensions.cs" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelWithItemExpansion.cs" -[[extensions]] -name = "AddChildNode" -sig = "void AddChildNode(this ITreeViewBuilder builder, - string rootNodeName, - string nodePath, - string name, - char pathSeparator, - bool unique, - string iconPath)" +[[methods]] +parent = "VirtualizingWrapPanelWithItemExpansion" +name = "GetGeneratorPositionFromChildIndex" +sig = "GeneratorPosition GetGeneratorPositionFromChildIndex(int childIndex)" +returns = "GeneratorPosition" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelWithItemExpansion.cs" + +[[methods]] +parent = "VirtualizingWrapPanelWithItemExpansion" +name = "VirtualizeItems" +sig = "void VirtualizeItems()" returns = "void" -file = "Extensions\\TreeViewBuilderExtensions.cs" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelWithItemExpansion.cs" -[[extensions]] -name = "AddChildNodes" -sig = "void AddChildNodes(this ITreeViewBuilder builder, - string rootNodeName, - IEnumerable childNodes)" +[[methods]] +parent = "VirtualizingWrapPanelWithItemExpansion" +name = "BringIndexIntoView" +sig = "void BringIndexIntoView(int index)" returns = "void" -file = "Extensions\\TreeViewBuilderExtensions.cs" +file = "Controls\\VirtualizingWrapPanelControl\\VirtualizingWrapPanelWithItemExpansion.cs" [[classes]] -name = "TreeViewItemExtensions" -ns = "FEx.WPFx.Extensions" -file = "Extensions\\TreeViewItemExtensions.cs" +name = "CmdLineHandler" +ns = "FEx.WPFx.SVG.SvgConverter" +file = "SVG\\SvgConverter\\CmdLineHandler.cs" static = true -[[extensions]] -name = "FullPath" -sig = "string FullPath(this HeaderedItemsControl sender)" -returns = "string" -file = "Extensions\\TreeViewItemExtensions.cs" +[[methods]] +parent = "CmdLineHandler" +name = "HandleCommandLine" +sig = "static int HandleCommandLine(string arg)" +returns = "int" +file = "SVG\\SvgConverter\\CmdLineHandler.cs" +static = true -[[classes]] -name = "UIElementExtensions" -ns = "FEx.WPFx.Extensions" -file = "Extensions\\UIElementExtensions.cs" +[[methods]] +parent = "CmdLineHandler" +name = "HandleCommandLine" +sig = "static int HandleCommandLine(string[] args)" +returns = "int" +file = "SVG\\SvgConverter\\CmdLineHandler.cs" static = true -[[extensions]] -name = "EnableUIElement" -sig = "void EnableUIElement(this UIElement element, bool inUIContext = false)" -returns = "void" -file = "Extensions\\UIElementExtensions.cs" +[[classes]] +name = "CmdLineTarget" +ns = "FEx.WPFx.SVG.SvgConverter" +file = "SVG\\SvgConverter\\CmdLineTarget.cs" -[[extensions]] -name = "DisableUIElement" -sig = "void DisableUIElement(this UIElement element, bool inUIContext = false)" -returns = "void" -file = "Extensions\\UIElementExtensions.cs" +[[methods]] +parent = "CmdLineTarget" +name = "BuildDict" +sig = "int BuildDict( //[ArgumentParam(Aliases = \"i\", Desc = \"dir to the SVGs\", LongDesc = \"specify folder of the graphic files to process\")] string inputdir, //[ArgumentParam(Aliases = \"o\", LongDesc = \"Name for the xaml outputfile\")] string outputname, //[ArgumentParam(DefaultValue = null, ExplicitNeeded = false, LongDesc = \"folder for the xaml-Output, optional, default: folder of svgs\")] string outputdir = null, //[ArgumentParam(LongDesc = \"Builds a htmlfile to browse the svgs, optional, default true\")] bool buildhtmlfile = true, //[ArgumentParam(DefaultValue = null, ExplicitNeeded = false, LongDesc = \"Prefix to name alll items of this file, optional, default: no prefix\")] string nameprefix = null, //[ArgumentParam(DefaultValue = false, ExplicitNeeded = false, LongDesc = \"If true, es explicit ResourceKey File is created, default: false\", ExplicitWantedArguments = \"resKeyNS,resKeyNSName\")] bool useComponentResKeys = false, //[ArgumentParam(DefaultValue = null, ExplicitNeeded = false, LongDesc = \"Namespace to use with UseResKey\")] string compResKeyNS = null, //[ArgumentParam(DefaultValue = null, ExplicitNeeded = false, LongDesc = \"name of Namespace to use with UseResKey\" )] string compResKeyNSName = null, //[ArgumentParam(DefaultValue = false, ExplicitNeeded = false, LongDesc = \"If true, PixelsPerDip is filtered to ensure compatibility for < 4.6.2, default: false\")] bool filterPixelsPerDip = false)" +returns = "int" +file = "SVG\\SvgConverter\\CmdLineTarget.cs" [[classes]] -name = "WindowsExtensions" -ns = "FEx.WPFx.Extensions" -file = "Extensions\\WindowsExtensions.cs" -static = true - -[[extensions]] -name = "GetWindowsScreen" -sig = "Screen GetWindowsScreen(this Window window)" -returns = "Screen" -summary = "Gets the screen on which window is present." -file = "Extensions\\WindowsExtensions.cs" +name = "ConvertedSvgData" +ns = "FEx.WPFx.SVG.SvgConverter" +file = "SVG\\SvgConverter\\ConvertedSvgData.cs" -[[extensions]] -name = "CenterWindowOnTheScreen" -sig = "void CenterWindowOnTheScreen(this Window window, Screen screen)" -returns = "void" -summary = "Centers the window on the screen." -file = "Extensions\\WindowsExtensions.cs" +[[properties]] +parent = "ConvertedSvgData" +name = "Filepath" +sig = "string Filepath { get; set; }" +returns = "string" +file = "SVG\\SvgConverter\\ConvertedSvgData.cs" -[[extensions]] -name = "GetDpiFactor" -sig = "Point GetDpiFactor(this Visual control)" -returns = "Point" -summary = "Centers the window on the screen." -file = "Extensions\\WindowsExtensions.cs" +[[properties]] +parent = "ConvertedSvgData" +name = "Xaml" +sig = "string Xaml { get; set; }" +returns = "string" +file = "SVG\\SvgConverter\\ConvertedSvgData.cs" -[[extensions]] -name = "CenterWindowOnTopOfTheOwner" -sig = "void CenterWindowOnTopOfTheOwner(this Window window)" -returns = "void" -summary = "Centers the window on top of the owner." -file = "Extensions\\WindowsExtensions.cs" +[[properties]] +parent = "ConvertedSvgData" +name = "Svg" +sig = "string Svg { get; set; }" +returns = "string" +file = "SVG\\SvgConverter\\ConvertedSvgData.cs" -[[extensions]] -name = "PlaceToPrimaryMonitor" -sig = "void PlaceToPrimaryMonitor(this Window window)" -returns = "void" -summary = "Places to primary monitor." -file = "Extensions\\WindowsExtensions.cs" +[[properties]] +parent = "ConvertedSvgData" +name = "ConvertedObj" +sig = "DrawingImage ConvertedObj { get; set; }" +returns = "DrawingImage" +file = "SVG\\SvgConverter\\ConvertedSvgData.cs" -[[extensions]] -name = "PlaceToMonitor" -sig = "void PlaceToMonitor(this Window window, Screen screen)" -returns = "void" -summary = "Places to primary monitor." -file = "Extensions\\WindowsExtensions.cs" +[[enums]] +name = "ResultMode" +ns = "FEx.WPFx.SVG.SvgConverter" +file = "SVG\\SvgConverter\\ConverterLogic.cs" [[classes]] -name = "ResourceIdHelper" -ns = "FEx.WPFx.Helpers" -file = "Helpers\\ResourceIdHelper.cs" +name = "ConverterLogic" +ns = "FEx.WPFx.SVG.SvgConverter" +file = "SVG\\SvgConverter\\ConverterLogic.cs" static = true -[[classes]] -name = "WpfCommon" -ns = "FEx.WPFx.Helpers" -file = "Helpers\\WpfCommon.cs" +[[properties]] +parent = "ConverterLogic" +name = "Nsx" +sig = "static XNamespace Nsx { get; }" +returns = "XNamespace" +file = "SVG\\SvgConverter\\ConverterLogic.cs" static = true -[[classes]] -name = "DispatcherContextExecutor" -ns = "FEx.WPFx.Implementations" -base = "FExDispatcher" -file = "Implementations\\DispatcherContextExecutor.cs" - -[[classes]] -name = "WpfMessagePopupService" -ns = "FEx.WPFx.Implementations" -base = "MessagePopupServiceBase, IDisposable" -file = "Implementations\\WpfMessagePopupService.cs" +[[properties]] +parent = "ConverterLogic" +name = "NsDef" +sig = "static XNamespace NsDef { get; }" +returns = "XNamespace" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[classes]] -name = "AppConfig" -ns = "FEx.WPFx.Models" -base = "IAppConfig" -file = "Models\\AppConfig.cs" +[[properties]] +parent = "ConverterLogic" +name = "NsManager" +sig = "static XmlNamespaceManager NsManager { get; }" +returns = "XmlNamespaceManager" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[classes]] -name = "HotkeyPayload" -ns = "FEx.WPFx.Models" -file = "Models\\HotkeyPayload.cs" +[[methods]] +parent = "ConverterLogic" +name = "SvgFileToXaml" +sig = "static string SvgFileToXaml(ConvertedSvgData svg, ResultMode resultMode, ResKeyInfo resKeyInfo, bool filterPixelsPerDip)" +returns = "string" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[classes]] -name = "ViewDesign" -ns = "FEx.WPFx.Models" -base = "NotifyPropertyChanged, IViewDesign" -file = "Models\\ViewDesign.cs" +[[methods]] +parent = "ConverterLogic" +name = "SvgFileToXaml" +sig = "static string SvgFileToXaml(ConvertedSvgData svg, ResultMode resultMode, ResKeyInfo resKeyInfo, bool filterPixelsPerDip, WpfDrawingSettings wpfDrawingSettings)" +returns = "string" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[classes]] -name = "CommonWindowsImaging" -ns = "FEx.WPFx.Natives" -file = "Natives\\CommonWindowsImaging.cs" +[[methods]] +parent = "ConverterLogic" +name = "ConvertSvg" +sig = "static ConvertedSvgData ConvertSvg(string filepath)" +returns = "ConvertedSvgData" +file = "SVG\\SvgConverter\\ConverterLogic.cs" static = true -[[classes]] -name = "FileUtil" -ns = "FEx.WPFx.Natives" -file = "Natives\\FileUtil.cs" +[[methods]] +parent = "ConverterLogic" +name = "ConvertSvg" +sig = "static ConvertedSvgData ConvertSvg(string svg, string fileName)" +returns = "ConvertedSvgData" +file = "SVG\\SvgConverter\\ConverterLogic.cs" static = true -[[enums]] -name = "RM_APP_TYPE" -ns = "FEx.WPFx.Natives" -file = "Natives\\FileUtil.cs" +[[methods]] +parent = "ConverterLogic" +name = "ConvertSvgToObject" +sig = "static object ConvertSvgToObject(ConvertedSvgData svg, ResultMode resultMode, WpfDrawingSettings wpfDrawingSettings, out string name, ResKeyInfo resKeyInfo)" +returns = "object" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[classes]] -name = "Monitorinfo" -ns = "FEx.WPFx.Natives" -file = "Natives\\MONITORINFO.cs" +[[methods]] +parent = "ConverterLogic" +name = "SvgObjectToXaml" +sig = "static string SvgObjectToXaml(object obj, bool includeRuntime, string name, bool filterPixelsPerDip)" +returns = "string" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[classes]] -name = "NativeImagingMethods" -ns = "FEx.WPFx.Natives" -summary = "Contains the external references to the unmanaged code." -file = "Natives\\NativeImagingMethods.cs" +[[methods]] +parent = "ConverterLogic" +name = "SvgDirToXaml" +sig = "static string SvgDirToXaml(string folder, ResKeyInfo resKeyInfo, bool filterPixelsPerDip)" +returns = "string" +file = "SVG\\SvgConverter\\ConverterLogic.cs" static = true -[[classes]] -name = "NativeMethods" -ns = "FEx.WPFx.Natives" -summary = "Contains the external references to the unmanaged code." -file = "Natives\\NativeMethods.cs" +[[methods]] +parent = "ConverterLogic" +name = "SvgDirToXaml" +sig = "static string SvgDirToXaml(string folder, ResKeyInfo resKeyInfo, WpfDrawingSettings wpfDrawingSettings, bool filterPixelsPerDip)" +returns = "string" +file = "SVG\\SvgConverter\\ConverterLogic.cs" static = true -[[extensions]] -name = "BringOnTop" -sig = "void BringOnTop(this Window window)" +[[methods]] +parent = "ConverterLogic" +name = "SvgFilesFromFolder" +sig = "static IEnumerable SvgFilesFromFolder(string folder)" +returns = "IEnumerable" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true + +[[methods]] +parent = "ConverterLogic" +name = "ReplaceBrushesInDrawingGroupsOld" +sig = "static void ReplaceBrushesInDrawingGroupsOld(XElement rootElement, ResKeyInfo resKeyInfo)" returns = "void" -summary = "Brings window to the foreground." -file = "Natives\\NativeMethods.cs" +summary = "This one uses local and global colors" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[extensions]] -name = "MaximizeWindow" -sig = "void MaximizeWindow(this Process proc)" +[[methods]] +parent = "ConverterLogic" +name = "ReplaceBrushesInDrawingGroups" +sig = "static void ReplaceBrushesInDrawingGroups(XElement rootElement)" returns = "void" -file = "Natives\\NativeMethods.cs" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[extensions]] -name = "MaximizeWindow" -sig = "void MaximizeWindow(this IntPtr hwnd)" +[[methods]] +parent = "ConverterLogic" +name = "GetPathGeometries" +sig = "static IEnumerable GetPathGeometries(Drawing drawing)" +returns = "IEnumerable" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true + +[[methods]] +parent = "ConverterLogic" +name = "SizeGeometry" +sig = "static void SizeGeometry(PathGeometry pg, Size size)" returns = "void" -file = "Natives\\NativeMethods.cs" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[extensions]] -name = "MinimizeWindow" -sig = "void MinimizeWindow(this Process proc)" +[[methods]] +parent = "ConverterLogic" +name = "RemoveNamespaceDeclarations" +sig = "static string RemoveNamespaceDeclarations(string xml)" +returns = "string" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true + +[[methods]] +parent = "ConverterLogic" +name = "RemoveObjectNames" +sig = "static void RemoveObjectNames(DrawingGroup drawingGroup)" returns = "void" -file = "Natives\\NativeMethods.cs" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[extensions]] -name = "MinimizeWindow" -sig = "void MinimizeWindow(this IntPtr hwnd)" +[[methods]] +parent = "ConverterLogic" +name = "ConvertFilesToResourceDictionary" +sig = "static ResourceDictionary ConvertFilesToResourceDictionary(IEnumerable files, WpfDrawingSettings wpfDrawingSettings, ResKeyInfo resKeyInfo)" +returns = "ResourceDictionary" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true + +[[methods]] +parent = "ConverterLogic" +name = "SetSizeToGeometries" +sig = "static void SetSizeToGeometries(DrawingGroup dg)" returns = "void" -file = "Natives\\NativeMethods.cs" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[classes]] -name = "ShellIcon" -ns = "FEx.WPFx.Natives" -summary = "Get a small or large Icon with an easy C# function call that returns a 32x32 or 16x16 System.Drawing.Icon depending on which function you call either GetSmallIcon(string fileName) or GetLargeIcon(string fileName)" -file = "Natives\\ShellIcon.cs" +[[methods]] +parent = "ConverterLogic" +name = "SvgFileToWpfObject" +sig = "static DrawingGroup SvgFileToWpfObject(ConvertedSvgData svg, WpfDrawingSettings wpfDrawingSettings)" +returns = "DrawingGroup" +file = "SVG\\SvgConverter\\ConverterLogic.cs" static = true -[[enums]] -name = "SHGFI" -ns = "FEx.WPFx.Natives" -file = "Natives\\SHGFI.cs" +[[methods]] +parent = "ConverterLogic" +name = "DrawingToImage" +sig = "static DrawingImage DrawingToImage(Drawing drawing)" +returns = "DrawingImage" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[enums]] -name = "ShowWindow" -ns = "FEx.WPFx.Natives" -file = "Natives\\ShowWindow.cs" +[[methods]] +parent = "ConverterLogic" +name = "WpfObjToXaml" +sig = "static string WpfObjToXaml(object wpfObject, bool includeRuntime)" +returns = "string" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[classes]] -name = "Win32" -ns = "FEx.WPFx.Natives" -file = "Natives\\Win32.cs" +[[methods]] +parent = "ConverterLogic" +name = "RemoveResDictEntries" +sig = "static void RemoveResDictEntries(XElement root)" +returns = "void" +file = "SVG\\SvgConverter\\ConverterLogic.cs" static = true -[[classes]] -name = "DispatcherService" -ns = "FEx.WPFx.Services" -file = "Services\\DispatcherService.cs" +[[methods]] +parent = "ConverterLogic" +name = "BuildDrawingGroupName" +sig = "static string BuildDrawingGroupName(string elementName, ResKeyInfo resKeyInfo)" +returns = "string" +file = "SVG\\SvgConverter\\ConverterLogic.cs" static = true -[[extensions]] -name = "GetDispatcherObject" -sig = "DispatcherObject GetDispatcherObject(this DispatcherObject sender)" -returns = "DispatcherObject" -summary = "Shows the view and waits until it's closed." -file = "Services\\DispatcherService.cs" +[[methods]] +parent = "ConverterLogic" +name = "BuildDrawingImageName" +sig = "static string BuildDrawingImageName(string elementName, ResKeyInfo resKeyInfo)" +returns = "string" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[classes]] -name = "WpfProgressStatusContainer" -ns = "FEx.WPFx.Services" -base = "ProgressAggregator, IWpfProgressStatusContainer" -file = "Services\\WpfProgressStatusContainer.cs" +[[methods]] +parent = "ConverterLogic" +name = "BuildGeometryName" +sig = "static string BuildGeometryName(string name, int? no, ResKeyInfo resKeyInfo)" +returns = "string" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[classes]] -name = "SvgCommon" -ns = "FEx.WPFx.SVG" -file = "SVG\\SvgCommon.cs" +[[methods]] +parent = "ConverterLogic" +name = "BuildColorName" +sig = "static string BuildColorName(int no, ResKeyInfo resKeyInfo)" +returns = "string" +file = "SVG\\SvgConverter\\ConverterLogic.cs" static = true -[[extensions]] -name = "ToMemoryStream" -sig = "MemoryStream ToMemoryStream(this DrawingImage drawingImage)" -returns = "MemoryStream" -summary = "Converts the SVG to image source." -file = "SVG\\SvgCommon.cs" +[[methods]] +parent = "ConverterLogic" +name = "BuildColorBrushName" +sig = "static string BuildColorBrushName(int no, ResKeyInfo resKeyInfo)" +returns = "string" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[extensions]] -name = "ToRenderTargetBitmap" -sig = "RenderTargetBitmap ToRenderTargetBitmap(this DrawingImage source)" -returns = "RenderTargetBitmap" -summary = "Converts the SVG to image source." -file = "SVG\\SvgCommon.cs" +[[methods]] +parent = "ConverterLogic" +name = "BuildResKey" +sig = "static string BuildResKey(string name, ResKeyInfo resKeyInfo)" +returns = "string" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[classes]] -name = "CmdLineHandler" -ns = "FEx.WPFx.SVG.SvgConverter" -file = "SVG\\SvgConverter\\CmdLineHandler.cs" +[[methods]] +parent = "ConverterLogic" +name = "BuildResKeyReference" +sig = "static string BuildResKeyReference(string refName, bool dynamic = false)" +returns = "string" +summary = "Builds resources keys reference" +file = "SVG\\SvgConverter\\ConverterLogic.cs" static = true -[[classes]] -name = "CmdLineTarget" -ns = "FEx.WPFx.SVG.SvgConverter" -file = "SVG\\SvgConverter\\CmdLineTarget.cs" +[[methods]] +parent = "ConverterLogic" +name = "GetElemNameFromResKey" +sig = "static string GetElemNameFromResKey(string name, ResKeyInfo resKeyInfo)" +returns = "string" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[classes]] -name = "ConvertedSvgData" -ns = "FEx.WPFx.SVG.SvgConverter" -file = "SVG\\SvgConverter\\ConvertedSvgData.cs" +[[methods]] +parent = "ConverterLogic" +name = "ValidateName" +sig = "static string ValidateName(string name)" +returns = "string" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true -[[classes]] -name = "ConverterLogic" -ns = "FEx.WPFx.SVG.SvgConverter" +[[methods]] +parent = "ConverterLogic" +name = "SetRootElementname" +sig = "static void SetRootElementname(DependencyObject drawingGroup, string name)" +returns = "void" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true + +[[methods]] +parent = "ConverterLogic" +name = "GetClipElement" +sig = "static XElement GetClipElement(XElement drawingGroupElement, out Rect rect)" +returns = "XElement" +file = "SVG\\SvgConverter\\ConverterLogic.cs" +static = true + +[[methods]] +parent = "ConverterLogic" +name = "GetSizeFromDrawingGroup" +sig = "static Size? GetSizeFromDrawingGroup(DrawingGroup drawingGroup)" +returns = "Size?" file = "SVG\\SvgConverter\\ConverterLogic.cs" static = true [[enums]] -name = "ResultMode" +name = "PathIs" ns = "FEx.WPFx.SVG.SvgConverter" -file = "SVG\\SvgConverter\\ConverterLogic.cs" +file = "SVG\\SvgConverter\\FileUtils.cs" [[classes]] name = "FileUtils" @@ -1074,79 +6807,59 @@ ns = "FEx.WPFx.SVG.SvgConverter" file = "SVG\\SvgConverter\\FileUtils.cs" static = true -[[enums]] -name = "PathIs" -ns = "FEx.WPFx.SVG.SvgConverter" +[[methods]] +parent = "FileUtils" +name = "MakeRelativePath" +sig = "static string MakeRelativePath(string fromPath, PathIs fromIs, string toPath, PathIs toIs)" +returns = "string" +summary = "Creates a relative path from one file or folder to another." file = "SVG\\SvgConverter\\FileUtils.cs" +static = true [[classes]] name = "ResKeyInfo" ns = "FEx.WPFx.SVG.SvgConverter" file = "SVG\\SvgConverter\\ResKeyInfo.cs" -[[classes]] -name = "NotEmptyValidationRule" -ns = "FEx.WPFx.Validation" -base = "ValidationRule" -file = "Validation\\NotEmptyValidationRule.cs" - -[[interfaces]] -name = "IWpfProgressInfo" -ns = "FEx.WPFx.ViewModels" -file = "ViewModels\\IWpfProgressInfo.cs" - -[[interfaces]] -name = "IWpfProgressInfoGet" -ns = "FEx.WPFx.ViewModels" -file = "ViewModels\\IWpfProgressInfo.cs" - -[[interfaces]] -name = "IWpfProgressListenerViewModel" -ns = "FEx.WPFx.ViewModels" -file = "ViewModels\\IWpfProgressListenerViewModel.cs" - -[[interfaces]] -name = "IWpfProgressReceiver" -ns = "FEx.WPFx.ViewModels" -file = "ViewModels\\IWpfProgressReceiver.cs" - -[[interfaces]] -name = "IWpfProgressStatusContainer" -ns = "FEx.WPFx.ViewModels" -file = "ViewModels\\IWpfProgressStatusContainer.cs" +[[properties]] +parent = "ResKeyInfo" +name = "Name" +sig = "string Name { get; set; }" +returns = "string" +file = "SVG\\SvgConverter\\ResKeyInfo.cs" -[[classes]] -name = "WpfProgressListenerViewModel" -ns = "FEx.WPFx.ViewModels" -base = "ProgressListenerViewModel, - IWpfProgressListenerViewModel" -file = "ViewModels\\WpfProgressListenerViewModel.cs" +[[properties]] +parent = "ResKeyInfo" +name = "XamlName" +sig = "string XamlName { get; set; }" +returns = "string" +file = "SVG\\SvgConverter\\ResKeyInfo.cs" -[[classes]] -name = "BindingErrorListener" -ns = "FEx.WPFx.WpfBindingErrors" -base = "IDisposable" -summary = "Raises an event each time a WPF Binding error occurs." -file = "WpfBindingErrors\\BindingErrorListener.cs" +[[properties]] +parent = "ResKeyInfo" +name = "Prefix" +sig = "string Prefix { get; set; }" +returns = "string" +file = "SVG\\SvgConverter\\ResKeyInfo.cs" -[[classes]] -name = "BindingException" -ns = "FEx.WPFx.WpfBindingErrors" -base = "Exception" -summary = "Exception thrown by the BindingExceptionThrower each time a WPF binding error occurs" -file = "WpfBindingErrors\\BindingException.cs" +[[properties]] +parent = "ResKeyInfo" +name = "UseComponentResKeys" +sig = "bool UseComponentResKeys { get; set; }" +returns = "bool" +file = "SVG\\SvgConverter\\ResKeyInfo.cs" -[[classes]] -name = "BindingExceptionThrower" -ns = "FEx.WPFx.WpfBindingErrors" -summary = "Converts WPF binding error into BindingException" -file = "WpfBindingErrors\\BindingExceptionThrower.cs" -static = true +[[properties]] +parent = "ResKeyInfo" +name = "NameSpace" +sig = "string NameSpace { get; set; }" +returns = "string" +file = "SVG\\SvgConverter\\ResKeyInfo.cs" -[[classes]] -name = "ObservableTraceListener" -ns = "FEx.WPFx.WpfBindingErrors" -base = "TraceListener" -summary = "A TraceListener that raise an event each time a trace is written" -file = "WpfBindingErrors\\ObservableTraceListener.cs" +[[properties]] +parent = "ResKeyInfo" +name = "NameSpaceName" +sig = "string NameSpaceName { get; set; }" +returns = "string" +file = "SVG\\SvgConverter\\ResKeyInfo.cs" diff --git a/.api-surface/FEx/WebScraping.toml b/.api-surface/FEx/WebScraping.toml index 694f0f2b..2b2bd45b 100644 --- a/.api-surface/FEx/WebScraping.toml +++ b/.api-surface/FEx/WebScraping.toml @@ -8,26 +8,288 @@ ns = "FEx.WebScraping" base = "IWebScraper" file = "HtmlWebHelper.cs" +[[methods]] +parent = "HtmlWebHelper" +name = "LoadHtmlDocumentAsync" +sig = "Task LoadHtmlDocumentAsync(Uri pageLink, Action configWeb, Encoding encoding, NetworkCredential credential, CancellationToken cancellationToken)" +returns = "Task" +file = "HtmlWebHelper.cs" + +[[methods]] +parent = "HtmlWebHelper" +name = "LoadAsync" +sig = "Task LoadAsync(Uri pageLink, Func action, Action configWeb, Encoding encoding, NetworkCredential credential, CancellationToken cancellationToken)" +returns = "Task" +file = "HtmlWebHelper.cs" + +[[methods]] +parent = "HtmlWebHelper" +name = "Load" +sig = "(HtmlWeb web, Task docTask) Load(Uri pageLink, Action configWeb, Encoding encoding, NetworkCredential credential, CancellationToken cancellationToken)" +returns = "(HtmlWeb web, Task docTask)" +file = "HtmlWebHelper.cs" + +[[methods]] +parent = "HtmlWebHelper" +name = "LoadHtmlDocumentAsync" +sig = "Task LoadHtmlDocumentAsync(HtmlWeb web, Uri pageLink, Encoding encoding, NetworkCredential credential, CancellationToken cancellationToken)" +returns = "Task" +file = "HtmlWebHelper.cs" + [[classes]] name = "XPathBuilderBase" ns = "FEx.WebScraping" file = "XPathBuilderBase.cs" +[[properties]] +parent = "XPathBuilderBase" +name = "SB" +sig = "StringBuilder SB { get; }" +returns = "StringBuilder" +file = "XPathBuilderBase.cs" + +[[ctors]] +parent = "XPathBuilderBase" +sig = "XPathBuilderBase()" +file = "XPathBuilderBase.cs" + +[[ctors]] +parent = "XPathBuilderBase" +sig = "XPathBuilderBase(HtmlNode node)" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "ToString" +sig = "string ToString()" +returns = "string" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "This" +sig = "T This()" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "AllChildElements" +sig = "T AllChildElements()" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "AllComments" +sig = "T AllComments()" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "AllDescedentElements" +sig = "T AllDescedentElements()" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "Attributes" +sig = "T Attributes(string attributeName)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "Elements" +sig = "T Elements(string element)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "ElementsAtLeastAnyAttribute" +sig = "T ElementsAtLeastAnyAttribute(string element)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "ElementsDescend" +sig = "T ElementsDescend(string element)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "First" +sig = "T First()" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "First" +sig = "T First(int number)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "Index" +sig = "T Index(int index)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "InnerText" +sig = "T InnerText()" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "Or" +sig = "T Or()" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "Parent" +sig = "T Parent()" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "WhereAttributeEquals" +sig = "T WhereAttributeEquals(string attributeName, string attributeValue)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "WhereClass" +sig = "T WhereClass(string className)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "WhereId" +sig = "T WhereId(string id)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "WhereIndex" +sig = "T WhereIndex(int number)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "WhereInnerTextEquals" +sig = "T WhereInnerTextEquals(string value)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "WhereInnerTextContains" +sig = "T WhereInnerTextContains(string value)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "WhereLast" +sig = "T WhereLast()" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "WhereLastMinus" +sig = "T WhereLastMinus(int number)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "WhereNotInnerTextContains" +sig = "T WhereNotInnerTextContains(string value)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "WhereClassStartWith" +sig = "T WhereClassStartWith(string attributeValue)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "WhereStartWith" +sig = "T WhereStartWith(string attributeName, string attributeValue)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "WhereStartWithId" +sig = "T WhereStartWithId(string attributeValue)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "WithExpression" +sig = "T WithExpression(Func xPath)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "WithExpression" +sig = "T WithExpression(T xPath)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "WithExpression" +sig = "T WithExpression(string xPath)" +returns = "T" +file = "XPathBuilderBase.cs" + +[[methods]] +parent = "XPathBuilderBase" +name = "ConcatXPath" +sig = "T ConcatXPath(string xPath)" +returns = "T" +file = "XPathBuilderBase.cs" + [[classes]] name = "XPathBuilderEx" ns = "FEx.WebScraping" base = "XPathBuilderBase" file = "XPathBuilderEx.cs" -[[interfaces]] -name = "IWebBrowserScraper" -ns = "FEx.WebScraping.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IWebBrowserScraper.cs" +[[ctors]] +parent = "XPathBuilderEx" +sig = "XPathBuilderEx()" +file = "XPathBuilderEx.cs" -[[interfaces]] -name = "IWebScraper" -ns = "FEx.WebScraping.Abstractions.Interfaces" -file = "Abstractions\\Interfaces\\IWebScraper.cs" +[[ctors]] +parent = "XPathBuilderEx" +sig = "XPathBuilderEx(HtmlNode node)" +file = "XPathBuilderEx.cs" [[classes]] name = "HtmlDocumentExtensions" @@ -37,14 +299,14 @@ static = true [[extensions]] name = "SaveToFile" -sig = "string SaveToFile(this HtmlDocument doc, string path)" returns = "string" +sig = "string SaveToFile(this HtmlDocument doc, string path)" file = "Extensions\\HtmlDocumentExtensions.cs" [[extensions]] name = "SaveToFile" -sig = "string SaveToFile(this HtmlDocument doc)" returns = "string" +sig = "string SaveToFile(this HtmlDocument doc)" file = "Extensions\\HtmlDocumentExtensions.cs" [[classes]] @@ -55,91 +317,82 @@ static = true [[extensions]] name = "GetNodeAttributeStringValue" -sig = "string GetNodeAttributeStringValue(this HtmlNode value, string name, string def)" returns = "string" +sig = "string GetNodeAttributeStringValue(this HtmlNode value, string name, string def)" summary = "Helper method to get the value of an attribute of this node. If the attribute is not found, the default value will be returned." file = "Extensions\\HtmlNodeExtensions.cs" [[extensions]] name = "GetNodeAttributeStringValue" -sig = "string GetNodeAttributeStringValue(this HtmlNode value, string name)" returns = "string" -summary = "Helper method to get the value of an attribute of this node. If the attribute is not found, the default value will be returned." +sig = "string GetNodeAttributeStringValue(this HtmlNode value, string name)" file = "Extensions\\HtmlNodeExtensions.cs" [[extensions]] name = "GetNodeAttributeBoolValue" -sig = "bool GetNodeAttributeBoolValue(this HtmlNode value, string name, bool def)" returns = "bool" -summary = "Helper method to get the value of an attribute of this node. If the attribute is not found, the default value will be returned." +sig = "bool GetNodeAttributeBoolValue(this HtmlNode value, string name, bool def)" file = "Extensions\\HtmlNodeExtensions.cs" [[extensions]] name = "GetNodeAttributeBoolValue" -sig = "bool GetNodeAttributeBoolValue(this HtmlNode value, string name)" returns = "bool" -summary = "Helper method to get the value of an attribute of this node. If the attribute is not found, the default value will be returned." +sig = "bool GetNodeAttributeBoolValue(this HtmlNode value, string name)" file = "Extensions\\HtmlNodeExtensions.cs" [[extensions]] name = "GetNodeAttributeIntValue" -sig = "int GetNodeAttributeIntValue(this HtmlNode value, string name, int def)" returns = "int" -summary = "Helper method to get the value of an attribute of this node. If the attribute is not found, the default value will be returned." +sig = "int GetNodeAttributeIntValue(this HtmlNode value, string name, int def)" file = "Extensions\\HtmlNodeExtensions.cs" [[extensions]] name = "GetNodeAttributeIntValue" -sig = "int GetNodeAttributeIntValue(this HtmlNode value, string name)" returns = "int" -summary = "Helper method to get the value of an attribute of this node. If the attribute is not found, the default value will be returned." +sig = "int GetNodeAttributeIntValue(this HtmlNode value, string name)" file = "Extensions\\HtmlNodeExtensions.cs" [[extensions]] name = "GetSrc" -sig = "string GetSrc(this HtmlNode value)" returns = "string" -summary = "Helper method to get the value of an attribute of this node. If the attribute is not found, the default value will be returned." +sig = "string GetSrc(this HtmlNode value)" file = "Extensions\\HtmlNodeExtensions.cs" [[extensions]] name = "GetHref" -sig = "string GetHref(this HtmlNode value)" returns = "string" -summary = "Helper method to get the value of an attribute of this node. If the attribute is not found, the default value will be returned." +sig = "string GetHref(this HtmlNode value)" file = "Extensions\\HtmlNodeExtensions.cs" [[extensions]] name = "GetNodeTypeAttributeValue" -sig = "string GetNodeTypeAttributeValue(this HtmlNode value)" returns = "string" -summary = "Helper method to get the value of an attribute of this node. If the attribute is not found, the default value will be returned." +sig = "string GetNodeTypeAttributeValue(this HtmlNode value)" file = "Extensions\\HtmlNodeExtensions.cs" [[extensions]] name = "IsNodeLinkElementOfType" -sig = "bool IsNodeLinkElementOfType(this HtmlNode value, string type)" returns = "bool" -summary = "Helper method to get the value of an attribute of this node. If the attribute is not found, the default value will be returned." +sig = "bool IsNodeLinkElementOfType(this HtmlNode value, string type)" file = "Extensions\\HtmlNodeExtensions.cs" [[extensions]] name = "IsInBody" -sig = "bool IsInBody(this HtmlNode value)" returns = "bool" +sig = "bool IsInBody(this HtmlNode value)" file = "Extensions\\HtmlNodeExtensions.cs" [[extensions]] name = "SelectSingleNode" -sig = "HtmlNode SelectSingleNode(this HtmlNode value, Func xpath)" returns = "HtmlNode" +sig = "HtmlNode SelectSingleNode(this HtmlNode value, Func xpath)" summary = "Selects the first XmlNode that matches the XPath expression." file = "Extensions\\HtmlNodeExtensions.cs" [[extensions]] name = "SelectNodes" -sig = "HtmlNodeCollection SelectNodes(this HtmlNode value, Func xpath)" returns = "HtmlNodeCollection" +sig = "HtmlNodeCollection SelectNodes(this HtmlNode value, Func xpath)" summary = "Selects a list of nodes matching the expression." file = "Extensions\\HtmlNodeExtensions.cs" @@ -151,33 +404,62 @@ static = true [[extensions]] name = "LoadHtmlDocumentAsync" -sig = "Task LoadHtmlDocumentAsync(this IWebBrowserScraper scraper, Uri pageLink)" returns = "Task" +sig = "Task LoadHtmlDocumentAsync(this IWebBrowserScraper scraper, Uri pageLink)" file = "Extensions\\WebBrowserScraperExtensions.cs" [[extensions]] name = "LoadHtmlDocumentAsync" -sig = "Task LoadHtmlDocumentAsync(this IWebBrowserScraper scraper, - Uri pageLink, - Action configWeb)" returns = "Task" +sig = "Task LoadHtmlDocumentAsync(this IWebBrowserScraper scraper, Uri pageLink, Action configWeb)" file = "Extensions\\WebBrowserScraperExtensions.cs" [[extensions]] name = "LoadAsync" -sig = "Task LoadAsync(this IWebBrowserScraper scraper, - Uri pageLink, - Action action)" returns = "Task" +sig = "Task LoadAsync(this IWebBrowserScraper scraper, Uri pageLink, Action action)" file = "Extensions\\WebBrowserScraperExtensions.cs" [[extensions]] name = "LoadAsync" -sig = "Task LoadAsync(this IWebBrowserScraper scraper, - Uri pageLink, - Action action, - Action configWeb)" returns = "Task" +sig = "Task LoadAsync(this IWebBrowserScraper scraper, Uri pageLink, Action action, Action configWeb)" +file = "Extensions\\WebBrowserScraperExtensions.cs" + +[[extensions]] +name = "LoadAsync" +returns = "Task" +sig = "Task LoadAsync(this IWebBrowserScraper scraper, Uri pageLink, Func action)" +file = "Extensions\\WebBrowserScraperExtensions.cs" + +[[extensions]] +name = "LoadAsync" +returns = "Task" +sig = "Task LoadAsync(this IWebBrowserScraper scraper, Uri pageLink, Func action, Action configWeb)" +file = "Extensions\\WebBrowserScraperExtensions.cs" + +[[extensions]] +name = "Load" +returns = "T" +sig = "T Load(this IWebBrowserScraper scraper, Uri pageLink, Func action)" +file = "Extensions\\WebBrowserScraperExtensions.cs" + +[[extensions]] +name = "Load" +returns = "T" +sig = "T Load(this IWebBrowserScraper scraper, Uri pageLink, Func action, Action configWeb)" +file = "Extensions\\WebBrowserScraperExtensions.cs" + +[[extensions]] +name = "Load" +returns = "(HtmlWeb web, HtmlDocument doc)" +sig = "(HtmlWeb web, HtmlDocument doc) Load(this IWebBrowserScraper scraper, Uri pageLink)" +file = "Extensions\\WebBrowserScraperExtensions.cs" + +[[extensions]] +name = "Load" +returns = "(HtmlWeb web, HtmlDocument doc)" +sig = "(HtmlWeb web, HtmlDocument doc) Load(this IWebBrowserScraper scraper, Uri pageLink, Action configWeb)" file = "Extensions\\WebBrowserScraperExtensions.cs" [[classes]] @@ -188,59 +470,164 @@ static = true [[extensions]] name = "LoadHtmlDocumentAsync" -sig = "Task LoadHtmlDocumentAsync(this IWebScraper scraper, Uri pageLink)" returns = "Task" +sig = "Task LoadHtmlDocumentAsync(this IWebScraper scraper, Uri pageLink)" file = "Extensions\\WebScraperExtensions.cs" [[extensions]] name = "LoadHtmlDocumentAsync" -sig = "Task LoadHtmlDocumentAsync(this IWebScraper scraper, - Uri pageLink, - Action configWeb)" returns = "Task" +sig = "Task LoadHtmlDocumentAsync(this IWebScraper scraper, Uri pageLink, Action configWeb)" file = "Extensions\\WebScraperExtensions.cs" [[extensions]] name = "LoadHtmlDocumentAsync" -sig = "Task LoadHtmlDocumentAsync(this IWebScraper scraper, - Uri pageLink, - Action configWeb, - Encoding encoding)" returns = "Task" +sig = "Task LoadHtmlDocumentAsync(this IWebScraper scraper, Uri pageLink, Action configWeb, Encoding encoding)" file = "Extensions\\WebScraperExtensions.cs" [[extensions]] name = "LoadHtmlDocumentAsync" -sig = "Task LoadHtmlDocumentAsync(this IWebScraper scraper, - Uri pageLink, - Action configWeb, - Encoding encoding, - NetworkCredential credential)" returns = "Task" +sig = "Task LoadHtmlDocumentAsync(this IWebScraper scraper, Uri pageLink, Action configWeb, Encoding encoding, NetworkCredential credential)" +file = "Extensions\\WebScraperExtensions.cs" + +[[extensions]] +name = "LoadAsync" +returns = "Task" +sig = "Task LoadAsync(this IWebScraper scraper, Uri pageLink, Func action)" +file = "Extensions\\WebScraperExtensions.cs" + +[[extensions]] +name = "LoadAsync" +returns = "Task" +sig = "Task LoadAsync(this IWebScraper scraper, Uri pageLink, Func action, Action configWeb)" +file = "Extensions\\WebScraperExtensions.cs" + +[[extensions]] +name = "LoadAsync" +returns = "Task" +sig = "Task LoadAsync(this IWebScraper scraper, Uri pageLink, Func action, Action configWeb, Encoding encoding)" +file = "Extensions\\WebScraperExtensions.cs" + +[[extensions]] +name = "LoadAsync" +returns = "Task" +sig = "Task LoadAsync(this IWebScraper scraper, Uri pageLink, Func action, Action configWeb, Encoding encoding, NetworkCredential credential)" file = "Extensions\\WebScraperExtensions.cs" [[extensions]] name = "LoadHtmlDocumentAsync" -sig = "Task LoadHtmlDocumentAsync(this IWebScraper scraper, HtmlWeb web, Uri pageLink)" returns = "Task" +sig = "Task LoadHtmlDocumentAsync(this IWebScraper scraper, HtmlWeb web, Uri pageLink)" file = "Extensions\\WebScraperExtensions.cs" [[extensions]] name = "LoadHtmlDocumentAsync" -sig = "Task LoadHtmlDocumentAsync(this IWebScraper scraper, - HtmlWeb web, - Uri pageLink, - Encoding encoding)" returns = "Task" +sig = "Task LoadHtmlDocumentAsync(this IWebScraper scraper, HtmlWeb web, Uri pageLink, Encoding encoding)" file = "Extensions\\WebScraperExtensions.cs" [[extensions]] name = "LoadHtmlDocumentAsync" -sig = "Task LoadHtmlDocumentAsync(this IWebScraper scraper, - HtmlWeb web, - Uri pageLink, - Encoding encoding, - NetworkCredential credential)" returns = "Task" +sig = "Task LoadHtmlDocumentAsync(this IWebScraper scraper, HtmlWeb web, Uri pageLink, Encoding encoding, NetworkCredential credential)" +file = "Extensions\\WebScraperExtensions.cs" + +[[extensions]] +name = "Load" +returns = "(HtmlWeb web, Task docTask)" +sig = "(HtmlWeb web, Task docTask) Load(this IWebScraper scraper, Uri pageLink)" +file = "Extensions\\WebScraperExtensions.cs" + +[[extensions]] +name = "Load" +returns = "(HtmlWeb web, Task docTask)" +sig = "(HtmlWeb web, Task docTask) Load(this IWebScraper scraper, Uri pageLink, Action configWeb)" +file = "Extensions\\WebScraperExtensions.cs" + +[[extensions]] +name = "Load" +returns = "(HtmlWeb web, Task docTask)" +sig = "(HtmlWeb web, Task docTask) Load(this IWebScraper scraper, Uri pageLink, Action configWeb, Encoding encoding)" file = "Extensions\\WebScraperExtensions.cs" +[[extensions]] +name = "Load" +returns = "(HtmlWeb web, Task docTask)" +sig = "(HtmlWeb web, Task docTask) Load(this IWebScraper scraper, Uri pageLink, Action configWeb, Encoding encoding, NetworkCredential credential)" +file = "Extensions\\WebScraperExtensions.cs" + +[[interfaces]] +name = "IWebBrowserScraper" +ns = "FEx.WebScraping.Abstractions.Interfaces" +file = "Abstractions\\Interfaces\\IWebBrowserScraper.cs" + +[[methods]] +parent = "IWebBrowserScraper" +name = "LoadHtmlDocumentAsync" +sig = "Task LoadHtmlDocumentAsync(Uri pageLink, Action configWeb, Func isBrowserScriptCompleted)" +returns = "Task" +file = "Abstractions\\Interfaces\\IWebBrowserScraper.cs" + +[[methods]] +parent = "IWebBrowserScraper" +name = "LoadAsync" +sig = "Task LoadAsync(Uri pageLink, Action action, Action configWeb, Func isBrowserScriptCompleted)" +returns = "Task" +file = "Abstractions\\Interfaces\\IWebBrowserScraper.cs" + +[[methods]] +parent = "IWebBrowserScraper" +name = "LoadAsync" +sig = "Task LoadAsync(Uri pageLink, Func action, Action configWeb, Func isBrowserScriptCompleted)" +returns = "Task" +file = "Abstractions\\Interfaces\\IWebBrowserScraper.cs" + +[[methods]] +parent = "IWebBrowserScraper" +name = "Load" +sig = "T Load(Uri pageLink, Func action, Action configWeb, Func isBrowserScriptCompleted)" +returns = "T" +file = "Abstractions\\Interfaces\\IWebBrowserScraper.cs" + +[[methods]] +parent = "IWebBrowserScraper" +name = "Load" +sig = "(HtmlWeb web, HtmlDocument doc) Load(Uri pageLink, Action configWeb, Func isBrowserScriptCompleted)" +returns = "(HtmlWeb web, HtmlDocument doc)" +file = "Abstractions\\Interfaces\\IWebBrowserScraper.cs" + +[[interfaces]] +name = "IWebScraper" +ns = "FEx.WebScraping.Abstractions.Interfaces" +file = "Abstractions\\Interfaces\\IWebScraper.cs" + +[[methods]] +parent = "IWebScraper" +name = "LoadHtmlDocumentAsync" +sig = "Task LoadHtmlDocumentAsync(Uri pageLink, Action configWeb, Encoding encoding, NetworkCredential credential, CancellationToken cancellationToken)" +returns = "Task" +file = "Abstractions\\Interfaces\\IWebScraper.cs" + +[[methods]] +parent = "IWebScraper" +name = "LoadAsync" +sig = "Task LoadAsync(Uri pageLink, Func action, Action configWeb, Encoding encoding, NetworkCredential credential, CancellationToken cancellationToken)" +returns = "Task" +file = "Abstractions\\Interfaces\\IWebScraper.cs" + +[[methods]] +parent = "IWebScraper" +name = "LoadHtmlDocumentAsync" +sig = "Task LoadHtmlDocumentAsync(HtmlWeb web, Uri pageLink, Encoding encoding, NetworkCredential credential, CancellationToken cancellationToken)" +returns = "Task" +file = "Abstractions\\Interfaces\\IWebScraper.cs" + +[[methods]] +parent = "IWebScraper" +name = "Load" +sig = "(HtmlWeb web, Task docTask) Load(Uri pageLink, Action configWeb, Encoding encoding, NetworkCredential credential, CancellationToken cancellationToken)" +returns = "(HtmlWeb web, Task docTask)" +file = "Abstractions\\Interfaces\\IWebScraper.cs" + diff --git a/.api-surface/FEx/Webx.toml b/.api-surface/FEx/Webx.toml index 0d486602..0213f8cc 100644 --- a/.api-surface/FEx/Webx.toml +++ b/.api-surface/FEx/Webx.toml @@ -7,11 +7,38 @@ name = "FExWebx" ns = "FEx.Webx" file = "FExWebx.cs" +[[properties]] +parent = "FExWebx" +name = "DefaultConnectionLimit" +sig = "static int DefaultConnectionLimit { get; set; }" +returns = "int" +file = "FExWebx.cs" +static = true + [[classes]] name = "HasInternetConnectionGate" ns = "FEx.Webx" file = "HasInternetConnectionGate.cs" +[[ctors]] +parent = "HasInternetConnectionGate" +sig = "HasInternetConnectionGate(IExceptionHandler exceptionHandler)" +file = "HasInternetConnectionGate.cs" + +[[methods]] +parent = "HasInternetConnectionGate" +name = "CheckAsync" +sig = "Task CheckAsync()" +returns = "Task" +file = "HasInternetConnectionGate.cs" + +[[methods]] +parent = "HasInternetConnectionGate" +name = "CheckAsync" +sig = "Task CheckAsync(Uri url)" +returns = "Task" +file = "HasInternetConnectionGate.cs" + [[classes]] name = "HttpResponseExtensions" ns = "FEx.Webx.Extensions" @@ -20,14 +47,14 @@ static = true [[extensions]] name = "GetDefaultExtension" -sig = "string GetDefaultExtension(this HttpResponseMessage response)" returns = "string" +sig = "string GetDefaultExtension(this HttpResponseMessage response)" file = "Extensions\\HttpResponseExtensions.cs" [[extensions]] name = "GetDefaultExtension" -sig = "string GetDefaultExtension(this HttpWebResponse response)" returns = "string" +sig = "string GetDefaultExtension(this HttpWebResponse response)" file = "Extensions\\HttpResponseExtensions.cs" [[classes]] @@ -36,6 +63,30 @@ ns = "FEx.Webx.Extensions" file = "Extensions\\JsonExtensions.cs" static = true +[[extensions]] +name = "DeserializeRemoteJsonAsync" +returns = "Task" +sig = "Task DeserializeRemoteJsonAsync(this Uri url)" +file = "Extensions\\JsonExtensions.cs" + +[[extensions]] +name = "DeserializeRemoteJsonAsync" +returns = "Task" +sig = "Task DeserializeRemoteJsonAsync(this Uri url, JsonSerializerSettings settings)" +file = "Extensions\\JsonExtensions.cs" + +[[extensions]] +name = "DeserializeRemoteJsonAsync" +returns = "Task" +sig = "Task DeserializeRemoteJsonAsync(this Uri url, JsonSerializerSettings settings, bool checkNetAvailability)" +file = "Extensions\\JsonExtensions.cs" + +[[extensions]] +name = "DeserializeRemoteJsonAsync" +returns = "Task" +sig = "Task DeserializeRemoteJsonAsync(this Uri url, JsonSerializerSettings settings, bool checkNetAvailability, CancellationToken cancellationToken)" +file = "Extensions\\JsonExtensions.cs" + [[classes]] name = "UriExtensions" ns = "FEx.Webx.Extensions" @@ -44,20 +95,32 @@ static = true [[extensions]] name = "GetFileNameAsync" +returns = "Task" sig = "Task GetFileNameAsync(this Uri url)" +file = "Extensions\\UriExtensions.cs" + +[[extensions]] +name = "GetFileNameAsync" returns = "Task" +sig = "Task GetFileNameAsync(this Uri url, WebRequestParams pars)" file = "Extensions\\UriExtensions.cs" [[extensions]] name = "GetFileName" -sig = "string GetFileName(this HttpWebResponse response)" returns = "string" +sig = "string GetFileName(this HttpWebResponse response)" file = "Extensions\\UriExtensions.cs" [[extensions]] name = "GetFileName" -sig = "string GetFileName(this HttpResponseMessage response)" returns = "string" +sig = "string GetFileName(this HttpResponseMessage response)" +file = "Extensions\\UriExtensions.cs" + +[[extensions]] +name = "DownloadStringAsync" +returns = "Task" +sig = "Task DownloadStringAsync(this Uri url)" file = "Extensions\\UriExtensions.cs" [[classes]] @@ -65,23 +128,101 @@ name = "ResponseResult" ns = "FEx.Webx.Models" file = "Models\\ResponseResult.cs" +[[properties]] +parent = "ResponseResult" +name = "IsSuccess" +sig = "bool IsSuccess { get; }" +returns = "bool" +summary = "Gets a value indicating whether this instance is success." +file = "Models\\ResponseResult.cs" + +[[properties]] +parent = "ResponseResult" +name = "ResponseBody" +sig = "string ResponseBody { get; }" +returns = "string" +summary = "Gets the response body." +file = "Models\\ResponseResult.cs" + +[[ctors]] +parent = "ResponseResult" +sig = "ResponseResult(bool isSuccess, string responseBody)" +summary = "Initializes a new instance of the class." +file = "Models\\ResponseResult.cs" + [[classes]] name = "MimeTypesUtility" ns = "FEx.Webx.Utilities" file = "Utilities\\MimeTypesUtility.cs" static = true +[[properties]] +parent = "MimeTypesUtility" +name = "RegistryService" +sig = "static IRegistryService RegistryService { get; }" +returns = "IRegistryService" +file = "Utilities\\MimeTypesUtility.cs" +static = true + +[[properties]] +parent = "MimeTypesUtility" +name = "TypeMap" +sig = "static ConcurrentDictionary TypeMap { get; }" +returns = "ConcurrentDictionary" +file = "Utilities\\MimeTypesUtility.cs" +static = true + +[[properties]] +parent = "MimeTypesUtility" +name = "Mappings" +sig = "static IReadOnlyDictionary Mappings { get; }" +returns = "IReadOnlyDictionary" +file = "Utilities\\MimeTypesUtility.cs" +static = true + [[extensions]] name = "GetDefaultExtensions" +returns = "IReadOnlyCollection" sig = "IReadOnlyCollection GetDefaultExtensions(this MediaTypeHeaderValue contentType)" +file = "Utilities\\MimeTypesUtility.cs" + +[[methods]] +parent = "MimeTypesUtility" +name = "GetDefaultExtensions" +sig = "static IReadOnlyCollection GetDefaultExtensions(MediaTypes mediaType)" returns = "IReadOnlyCollection" file = "Utilities\\MimeTypesUtility.cs" +static = true + +[[methods]] +parent = "MimeTypesUtility" +name = "GetDefaultExtensions" +sig = "static IReadOnlyCollection GetDefaultExtensions(string mimeType)" +returns = "IReadOnlyCollection" +file = "Utilities\\MimeTypesUtility.cs" +static = true + +[[methods]] +parent = "MimeTypesUtility" +name = "GetDefaultMimeType" +sig = "static string GetDefaultMimeType(string extension)" +returns = "string" +file = "Utilities\\MimeTypesUtility.cs" +static = true [[extensions]] name = "GetDefaultExtension" +returns = "string" sig = "string GetDefaultExtension(this MediaTypeHeaderValue contentType)" +file = "Utilities\\MimeTypesUtility.cs" + +[[methods]] +parent = "MimeTypesUtility" +name = "GetDefaultExtension" +sig = "static string GetDefaultExtension(string contentType, string fileName)" returns = "string" file = "Utilities\\MimeTypesUtility.cs" +static = true [[classes]] name = "NetworkUtilities" @@ -90,3 +231,21 @@ summary = "Network-related utilities." file = "Utilities\\NetworkUtilities.cs" static = true +[[methods]] +parent = "NetworkUtilities" +name = "GetAllLocalIPv4" +sig = "static Dictionary> GetAllLocalIPv4(bool omitLoopbacks = true)" +returns = "Dictionary>" +summary = "Gets the local ip addresses." +file = "Utilities\\NetworkUtilities.cs" +static = true + +[[methods]] +parent = "NetworkUtilities" +name = "GetCredentials" +sig = "static ICredentials GetCredentials(string username = \"\", string password = \"\")" +returns = "ICredentials" +summary = "Creates network credentials from username and password, or returns default credentials if not provided." +file = "Utilities\\NetworkUtilities.cs" +static = true + diff --git a/.api-surface/FEx/_meta.toml b/.api-surface/FEx/_meta.toml index 9043965c..19a716e4 100644 --- a/.api-surface/FEx/_meta.toml +++ b/.api-surface/FEx/_meta.toml @@ -1,8 +1,11 @@ [meta] repo = "FEx" -generated = "2026-06-19 23:22:53" -git_commit = "3ee69e3" -classes = 686 +generated = "2026-06-20 12:27:14" +git_commit = "33c578a" +classes = 692 interfaces = 188 enums = 44 -extensions = 485 +extensions = 833 +ctors = 431 +methods = 2643 +properties = 1643 diff --git a/FEx.slnx b/FEx.slnx index 8d83513b..dab7d353 100644 --- a/FEx.slnx +++ b/FEx.slnx @@ -50,6 +50,9 @@ + + + @@ -115,6 +118,14 @@ + + + + + + + + @@ -210,6 +221,12 @@ + + + + + + diff --git a/Generate-ApiSurface.ps1 b/Generate-ApiSurface.ps1 index adccca85..1f44f6f9 100644 --- a/Generate-ApiSurface.ps1 +++ b/Generate-ApiSurface.ps1 @@ -2,17 +2,17 @@ .SYNOPSIS Generates per-project TOML API surface maps for AI agent consumption. .DESCRIPTION - Scans C# source code in a given repo/solution and generates one TOML file per project - under .api-surface//. Extracts public and internal classes, interfaces, enums, - extension methods, and their XML doc summaries. + Thin wrapper over the Roslyn-based extractor (tools/FEx.ApiSurfaceGen). Scans C# source in a + given repo and generates one TOML file per project under .api-surface//, including types, + constructors, methods (with default values and generic constraints), properties, and extension + methods. After generation, auto-syncs the surface to the Obsidian vault. .PARAMETER RepoPath - Path to the repository root (e.g., "FEx"). - Relative to this script's location or absolute. + Path to the repository root (e.g., "FEx"). Relative to this script's location or absolute. .PARAMETER OutputDir Output directory. Defaults to ".api-surface/". .EXAMPLE .\Generate-ApiSurface.ps1 -RepoPath FEx - .\Generate-ApiSurface.ps1 -RepoPath FEx -Verbose + .\Generate-ApiSurface.ps1 -RepoPath . #> [CmdletBinding()] @@ -38,244 +38,19 @@ if (-not $OutputDir) { $OutputDir = Join-Path $ScriptRoot ".api-surface" $repoName } -# Ensure output dir exists (clean previous) -if (Test-Path $OutputDir) { - Remove-Item "$OutputDir\*.toml" -Force -ErrorAction SilentlyContinue -} -New-Item -ItemType Directory -Path $OutputDir -Force | Out-Null - -# Excluded directory patterns -$excludePatterns = @('\\obj\\', '\\bin\\', '\\submodules\\', '\\samples\\', '\\TestResults\\') - -#region Helper Functions - -function Get-XmlDocSummary { - param([string[]]$Lines, [int]$StartIndex) - - $summary = [System.Collections.ArrayList]@() - $inSummary = $false - - for ($i = $StartIndex; $i -ge [Math]::Max(0, $StartIndex - 30); $i--) { - $line = $Lines[$i] - if ($line -match '^\s*///(.*)$') { - $content = $matches[1].Trim() - if ($content -match '') { - $inSummary = $true - $textBefore = $content -replace '.*', '' -replace '', '' - if ($textBefore.Trim()) { [void]$summary.Insert(0, $textBefore.Trim()) } - } - elseif ($inSummary) { - if ($content -match '(.*)') { - $textAfter = $matches[1].Trim() - if ($textAfter) { [void]$summary.Insert(0, $textAfter) } - break - } - else { - $clean = ($content -replace '<[^>]+>', '').Trim() - if ($clean) { [void]$summary.Insert(0, $clean) } - } - } - } - elseif ($inSummary) { break } - } - - return (($summary -join ' ').Trim() -replace '\s+', ' ') -} - -function Parse-CSharpFile { - param([string]$FilePath, [string]$ProjectRoot) - - $content = Get-Content $FilePath -Raw -ErrorAction SilentlyContinue - if (-not $content) { return @{ Classes = @(); Interfaces = @(); Enums = @(); ExtensionMethods = @() } } - - $lines = Get-Content $FilePath - $relativePath = $FilePath.Substring($ProjectRoot.Length).TrimStart('\', '/') - - # Namespace - $nsMatch = [regex]::Match($content, 'namespace\s+([\w\.]+)') - $ns = if ($nsMatch.Success) { $nsMatch.Groups[1].Value } else { "" } - - $result = @{ Classes = @(); Interfaces = @(); Enums = @(); ExtensionMethods = @() } - - # Public/internal classes - $classMatches = [regex]::Matches($content, '(?m)^\s*(?:public|internal)\s+(?:static\s+|abstract\s+|sealed\s+|partial\s+)*class\s+(\w+)(?:<[^>]+>)?\s*(?::\s*([^{]+))?') - foreach ($m in $classMatches) { - $lineNum = ($content.Substring(0, $m.Index) -split "`n").Count - $result.Classes += @{ - Name = $m.Groups[1].Value - Ns = $ns - Base = $m.Groups[2].Value.Trim() - Summary = Get-XmlDocSummary -Lines $lines -StartIndex ($lineNum - 2) - File = $relativePath - IsStatic = $m.Value -match '\bstatic\b' - } - } - - # Public/internal interfaces - $ifaceMatches = [regex]::Matches($content, '(?m)^\s*(?:public|internal)\s+(?:partial\s+)?interface\s+(I\w+)(?:<[^>]+>)?') - foreach ($m in $ifaceMatches) { - $lineNum = ($content.Substring(0, $m.Index) -split "`n").Count - $result.Interfaces += @{ - Name = $m.Groups[1].Value - Ns = $ns - Summary = Get-XmlDocSummary -Lines $lines -StartIndex ($lineNum - 2) - File = $relativePath - } - } - - # Public enums - $enumMatches = [regex]::Matches($content, '(?m)^\s*(?:public|internal)\s+enum\s+(\w+)') - foreach ($m in $enumMatches) { - $lineNum = ($content.Substring(0, $m.Index) -split "`n").Count - $result.Enums += @{ - Name = $m.Groups[1].Value - Ns = $ns - Summary = Get-XmlDocSummary -Lines $lines -StartIndex ($lineNum - 2) - File = $relativePath - } - } - - # Extension methods - $extMatches = [regex]::Matches($content, '(?m)^\s*public\s+static\s+(\w+(?:<[^>]+>)?(?:\[\])?)\s+(\w+)\s*\(([^)]*\bthis\b[^)]*)\)') - foreach ($m in $extMatches) { - $lineNum = ($content.Substring(0, $m.Index) -split "`n").Count - $result.ExtensionMethods += @{ - Name = $m.Groups[2].Value - Returns = $m.Groups[1].Value - Sig = "$($m.Groups[1].Value) $($m.Groups[2].Value)($($m.Groups[3].Value))" - Summary = Get-XmlDocSummary -Lines $lines -StartIndex ($lineNum - 1) - File = $relativePath - } - } - - return $result -} - -function Escape-TomlString { - param([string]$Value) - if (-not $Value) { return '""' } - $escaped = $Value -replace '\\', '\\' -replace '"', '\"' - return "`"$escaped`"" -} - -function Write-TomlEntry { - param([string]$Type, [hashtable]$Item) - $sb = [System.Text.StringBuilder]::new() - [void]$sb.AppendLine("[[$Type]]") - [void]$sb.AppendLine("name = $(Escape-TomlString $Item.Name)") - if ($Item.Ns) { [void]$sb.AppendLine("ns = $(Escape-TomlString $Item.Ns)") } - if ($Item.Base) { [void]$sb.AppendLine("base = $(Escape-TomlString $Item.Base)") } - if ($Item.Sig) { [void]$sb.AppendLine("sig = $(Escape-TomlString $Item.Sig)") } - if ($Item.Returns) { [void]$sb.AppendLine("returns = $(Escape-TomlString $Item.Returns)") } - if ($Item.Summary) { [void]$sb.AppendLine("summary = $(Escape-TomlString $Item.Summary)") } - if ($Item.File) { [void]$sb.AppendLine("file = $(Escape-TomlString $Item.File)") } - if ($Item.IsStatic) { [void]$sb.AppendLine("static = true") } - [void]$sb.AppendLine() - return $sb.ToString() +$genProject = Join-Path $ScriptRoot "tools" "FEx.ApiSurfaceGen" "FEx.ApiSurfaceGen.csproj" +if (-not (Test-Path $genProject)) { + Write-Error "Extractor project not found: $genProject" + return } -#endregion - -#region Main - -Write-Host "Scanning $repoName..." -ForegroundColor Cyan - -# Find all .csproj files -$projectFiles = Get-ChildItem -Path $resolvedRepo -Filter "*.csproj" -Recurse | - Where-Object { - $path = $_.FullName - -not ($excludePatterns | Where-Object { $path -match $_ }) - } | - Sort-Object Name - -Write-Host "Found $($projectFiles.Count) projects" -ForegroundColor Green - -$totalClasses = 0 -$totalInterfaces = 0 -$totalEnums = 0 -$totalExtMethods = 0 - -foreach ($projectFile in $projectFiles) { - $projectDir = Split-Path $projectFile.FullName - $projectName = ($projectFile.BaseName) - - # Strip common prefixes for filename - $tomlName = $projectName -replace '^FEx\.', '' - $tomlFile = Join-Path $OutputDir "$tomlName.toml" - - Write-Verbose "Processing: $projectName -> $tomlName.toml" - - $csFiles = Get-ChildItem -Path $projectDir -Filter "*.cs" -Recurse | - Where-Object { - $path = $_.FullName - -not ($excludePatterns | Where-Object { $path -match $_ }) - } - - $toml = [System.Text.StringBuilder]::new() - - # Project header - [void]$toml.AppendLine("[project]") - [void]$toml.AppendLine("name = $(Escape-TomlString $projectName)") - $relProjectPath = $projectDir.Substring($resolvedRepo.Length).TrimStart('\', '/') - [void]$toml.AppendLine("path = $(Escape-TomlString $relProjectPath)") - [void]$toml.AppendLine() - - $hasContent = $false - - foreach ($csFile in $csFiles) { - $parsed = Parse-CSharpFile -FilePath $csFile.FullName -ProjectRoot $projectDir - - foreach ($cls in $parsed.Classes) { - [void]$toml.Append((Write-TomlEntry -Type "classes" -Item $cls)) - $totalClasses++ - $hasContent = $true - } - foreach ($iface in $parsed.Interfaces) { - [void]$toml.Append((Write-TomlEntry -Type "interfaces" -Item $iface)) - $totalInterfaces++ - $hasContent = $true - } - foreach ($enum in $parsed.Enums) { - [void]$toml.Append((Write-TomlEntry -Type "enums" -Item $enum)) - $totalEnums++ - $hasContent = $true - } - foreach ($ext in $parsed.ExtensionMethods) { - [void]$toml.Append((Write-TomlEntry -Type "extensions" -Item $ext)) - $totalExtMethods++ - $hasContent = $true - } - } - - if ($hasContent) { - $toml.ToString() | Out-File -FilePath $tomlFile -Encoding UTF8 -NoNewline - Write-Verbose " -> $tomlName.toml" - } +# Run the Roslyn extractor (builds on first run) +dotnet run --project $genProject -c Release -- -RepoPath $resolvedRepo -OutputDir $OutputDir +if ($LASTEXITCODE -ne 0) { + Write-Error "API surface generation failed (exit code $LASTEXITCODE)" + return } -# Write _meta.toml -$gitHash = git -C $resolvedRepo rev-parse --short HEAD 2>$null -if (-not $gitHash) { $gitHash = "unknown" } - -@" -[meta] -repo = $(Escape-TomlString $repoName) -generated = $(Escape-TomlString (Get-Date -Format "yyyy-MM-dd HH:mm:ss")) -git_commit = $(Escape-TomlString $gitHash) -classes = $totalClasses -interfaces = $totalInterfaces -enums = $totalEnums -extensions = $totalExtMethods -"@ | Out-File -FilePath (Join-Path $OutputDir "_meta.toml") -Encoding UTF8 - -Write-Host "" -Write-Host "Summary ($repoName):" -ForegroundColor Cyan -Write-Host " Classes: $totalClasses" -Write-Host " Interfaces: $totalInterfaces" -Write-Host " Enums: $totalEnums" -Write-Host " Extensions: $totalExtMethods" -Write-Host " Output: $OutputDir" -ForegroundColor Green - # Auto-sync to Obsidian vault $syncScript = Join-Path $ScriptRoot "Sync-ApiSurfaceToObsidian.ps1" if (Test-Path $syncScript) { @@ -283,5 +58,3 @@ if (Test-Path $syncScript) { Write-Host "Syncing to Obsidian vault..." -ForegroundColor Cyan & $syncScript -ApiSurfacePath $OutputDir } - -#endregion diff --git a/tools/FEx.ApiSurfaceGen/FEx.ApiSurfaceGen.csproj b/tools/FEx.ApiSurfaceGen/FEx.ApiSurfaceGen.csproj new file mode 100644 index 00000000..351fe4c4 --- /dev/null +++ b/tools/FEx.ApiSurfaceGen/FEx.ApiSurfaceGen.csproj @@ -0,0 +1,17 @@ + + + + Exe + net10.0 + false + FEx.ApiSurfaceGen + disable + disable + latest + + + + + + + diff --git a/tools/FEx.ApiSurfaceGen/Program.cs b/tools/FEx.ApiSurfaceGen/Program.cs new file mode 100644 index 00000000..f4d18e6a --- /dev/null +++ b/tools/FEx.ApiSurfaceGen/Program.cs @@ -0,0 +1,481 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Text; +using Microsoft.CodeAnalysis; +using Microsoft.CodeAnalysis.CSharp; +using Microsoft.CodeAnalysis.CSharp.Syntax; + +namespace FEx.ApiSurfaceGen; + +// Roslyn-based API surface extractor. Replaces the regex extraction in Generate-ApiSurface.ps1. +// Parses each .cs file into a syntax tree and renders exact member signatures (default values, +// generic constraints, multi-line declarations, overloads) that regex cannot reliably capture. +internal static class Program +{ + private static int Main(string[] args) + { + var repoPath = GetArg(args, "-RepoPath"); + var outputDir = GetArg(args, "-OutputDir"); + + if (string.IsNullOrEmpty(repoPath)) + { + Console.Error.WriteLine("Usage: FEx.ApiSurfaceGen -RepoPath [-OutputDir ]"); + return 1; + } + + repoPath = Path.GetFullPath(repoPath); + if (!Directory.Exists(repoPath)) + { + Console.Error.WriteLine($"Repository not found: {repoPath}"); + return 1; + } + + var repoName = new DirectoryInfo(repoPath).Name; + if (string.IsNullOrEmpty(outputDir)) + outputDir = Path.Combine(AppContext.BaseDirectory, ".api-surface", repoName); + + outputDir = Path.GetFullPath(outputDir); + Directory.CreateDirectory(outputDir); + foreach (var stale in Directory.GetFiles(outputDir, "*.toml")) + File.Delete(stale); + + Console.WriteLine($"Scanning {repoName}..."); + + var projectFiles = Directory + .EnumerateFiles(repoPath, "*.csproj", SearchOption.AllDirectories) + .Where(p => !IsExcluded(p)) + .OrderBy(p => Path.GetFileName(p), StringComparer.Ordinal) + .ToList(); + + Console.WriteLine($"Found {projectFiles.Count} projects"); + + var totals = new Totals(); + + foreach (var projectFile in projectFiles) + { + var projectDir = Path.GetDirectoryName(projectFile)!; + var projectName = Path.GetFileNameWithoutExtension(projectFile); + var tomlName = projectName.StartsWith("FEx.", StringComparison.Ordinal) + ? projectName.Substring(4) + : projectName; + var tomlFile = Path.Combine(outputDir, tomlName + ".toml"); + + var csFiles = Directory + .EnumerateFiles(projectDir, "*.cs", SearchOption.AllDirectories) + .Where(p => !IsExcluded(p)) + .ToList(); + + var sb = new StringBuilder(); + sb.AppendLine("[project]"); + sb.AppendLine($"name = {TomlString(projectName)}"); + var relProjectPath = RelativePath(projectDir, repoPath); + sb.AppendLine($"path = {TomlString(relProjectPath)}"); + sb.AppendLine(); + + var hasContent = false; + + foreach (var csFile in csFiles) + hasContent |= ProcessFile(csFile, projectDir, sb, totals); + + if (hasContent) + File.WriteAllText(tomlFile, sb.ToString(), new UTF8Encoding(false)); + } + + var gitHash = ReadGitHeadShort(repoPath); + var meta = new StringBuilder(); + meta.AppendLine("[meta]"); + meta.AppendLine($"repo = {TomlString(repoName)}"); + meta.AppendLine($"generated = {TomlString(DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"))}"); + meta.AppendLine($"git_commit = {TomlString(gitHash)}"); + meta.AppendLine($"classes = {totals.Classes}"); + meta.AppendLine($"interfaces = {totals.Interfaces}"); + meta.AppendLine($"enums = {totals.Enums}"); + meta.AppendLine($"extensions = {totals.Extensions}"); + meta.AppendLine($"ctors = {totals.Ctors}"); + meta.AppendLine($"methods = {totals.Methods}"); + meta.AppendLine($"properties = {totals.Properties}"); + File.WriteAllText(Path.Combine(outputDir, "_meta.toml"), meta.ToString(), new UTF8Encoding(false)); + + Console.WriteLine(); + Console.WriteLine($"Summary ({repoName}):"); + Console.WriteLine($" Classes: {totals.Classes}"); + Console.WriteLine($" Interfaces: {totals.Interfaces}"); + Console.WriteLine($" Enums: {totals.Enums}"); + Console.WriteLine($" Extensions: {totals.Extensions}"); + Console.WriteLine($" Ctors: {totals.Ctors}"); + Console.WriteLine($" Methods: {totals.Methods}"); + Console.WriteLine($" Properties: {totals.Properties}"); + Console.WriteLine($" Output: {outputDir}"); + return 0; + } + + private static bool ProcessFile(string filePath, string projectDir, StringBuilder toml, Totals totals) + { + string text; + try { text = File.ReadAllText(filePath); } + catch { return false; } + + if (string.IsNullOrWhiteSpace(text)) + return false; + + var tree = CSharpSyntaxTree.ParseText(text); + var root = tree.GetRoot(); + var relativePath = RelativePath(filePath, projectDir); + var hasContent = false; + + foreach (var type in root.DescendantNodes().OfType()) + { + // Match the legacy filter: only types explicitly public/internal reach the surface. + if (!IsTypeVisible(type.Modifiers)) + continue; + + var ns = GetNamespace(type); + + switch (type) + { + case ClassDeclarationSyntax cls: + hasContent |= WriteType(toml, "classes", cls.Identifier.Text, ns, + BaseList(cls.BaseList), IsStatic(cls.Modifiers), relativePath, Summary(cls), totals); + hasContent |= WriteMembers(toml, cls, cls.Identifier.Text, isInterface: false, relativePath, totals); + break; + + case StructDeclarationSyntax st: + hasContent |= WriteType(toml, "classes", st.Identifier.Text, ns, + BaseList(st.BaseList), IsStatic(st.Modifiers), relativePath, Summary(st), totals); + hasContent |= WriteMembers(toml, st, st.Identifier.Text, isInterface: false, relativePath, totals); + break; + + case RecordDeclarationSyntax rec: + hasContent |= WriteType(toml, "classes", rec.Identifier.Text, ns, + BaseList(rec.BaseList), IsStatic(rec.Modifiers), relativePath, Summary(rec), totals); + hasContent |= WriteMembers(toml, rec, rec.Identifier.Text, isInterface: false, relativePath, totals); + break; + + case InterfaceDeclarationSyntax iface: + hasContent |= WriteType(toml, "interfaces", iface.Identifier.Text, ns, + BaseList(iface.BaseList), isStatic: false, relativePath, Summary(iface), totals); + hasContent |= WriteMembers(toml, iface, iface.Identifier.Text, isInterface: true, relativePath, totals); + break; + + case EnumDeclarationSyntax en: + hasContent |= WriteType(toml, "enums", en.Identifier.Text, ns, + baseList: "", isStatic: false, relativePath, Summary(en), totals); + break; + } + } + + return hasContent; + } + + private static bool WriteType(StringBuilder toml, string section, string name, string ns, + string baseList, bool isStatic, string file, string summary, Totals totals) + { + // Match the legacy filter: only public/internal types reach the surface. + // (Nested types keep their declared accessibility; private nested types are skipped by the caller's modifier check below.) + toml.AppendLine($"[[{section}]]"); + toml.AppendLine($"name = {TomlString(name)}"); + if (!string.IsNullOrEmpty(ns)) toml.AppendLine($"ns = {TomlString(ns)}"); + if (!string.IsNullOrEmpty(baseList)) toml.AppendLine($"base = {TomlString(baseList)}"); + if (!string.IsNullOrEmpty(summary)) toml.AppendLine($"summary = {TomlString(summary)}"); + if (!string.IsNullOrEmpty(file)) toml.AppendLine($"file = {TomlString(file)}"); + if (isStatic) toml.AppendLine("static = true"); + toml.AppendLine(); + + switch (section) + { + case "classes": totals.Classes++; break; + case "interfaces": totals.Interfaces++; break; + case "enums": totals.Enums++; break; + } + + return true; + } + + private static bool WriteMembers(StringBuilder toml, TypeDeclarationSyntax type, string parent, + bool isInterface, string file, Totals totals) + { + var any = false; + + foreach (var member in type.Members) + { + switch (member) + { + case ConstructorDeclarationSyntax ctor when IsApiVisible(ctor.Modifiers, isInterface): + { + var sig = ctor.Identifier.Text + NormalizeWs(ctor.ParameterList.ToString()); + toml.AppendLine("[[ctors]]"); + toml.AppendLine($"parent = {TomlString(parent)}"); + toml.AppendLine($"sig = {TomlString(sig)}"); + AppendSummaryFile(toml, Summary(ctor), file); + if (IsStatic(ctor.Modifiers)) toml.AppendLine("static = true"); + toml.AppendLine(); + totals.Ctors++; + any = true; + break; + } + + case MethodDeclarationSyntax method when IsApiVisible(method.Modifiers, isInterface): + { + if (IsExtensionMethod(type, method)) + { + var ret = method.ReturnType.ToString(); + var extSig = $"{ret} {method.Identifier.Text}{method.TypeParameterList}" + + NormalizeWs(method.ParameterList.ToString()); + toml.AppendLine("[[extensions]]"); + toml.AppendLine($"name = {TomlString(method.Identifier.Text)}"); + toml.AppendLine($"returns = {TomlString(ret)}"); + toml.AppendLine($"sig = {TomlString(extSig)}"); + AppendSummaryFile(toml, Summary(method), file); + toml.AppendLine(); + totals.Extensions++; + any = true; + break; + } + + var sig = RenderMethod(method); + toml.AppendLine("[[methods]]"); + toml.AppendLine($"parent = {TomlString(parent)}"); + toml.AppendLine($"name = {TomlString(method.Identifier.Text)}"); + toml.AppendLine($"sig = {TomlString(sig)}"); + toml.AppendLine($"returns = {TomlString(method.ReturnType.ToString())}"); + AppendSummaryFile(toml, Summary(method), file); + if (IsStatic(method.Modifiers)) toml.AppendLine("static = true"); + toml.AppendLine(); + totals.Methods++; + any = true; + break; + } + + case PropertyDeclarationSyntax prop when IsApiVisible(prop.Modifiers, isInterface): + { + var sig = RenderProperty(prop); + toml.AppendLine("[[properties]]"); + toml.AppendLine($"parent = {TomlString(parent)}"); + toml.AppendLine($"name = {TomlString(prop.Identifier.Text)}"); + toml.AppendLine($"sig = {TomlString(sig)}"); + toml.AppendLine($"returns = {TomlString(prop.Type.ToString())}"); + AppendSummaryFile(toml, Summary(prop), file); + if (IsStatic(prop.Modifiers)) toml.AppendLine("static = true"); + toml.AppendLine(); + totals.Properties++; + any = true; + break; + } + } + } + + return any; + } + + private static string RenderMethod(MethodDeclarationSyntax method) + { + var sb = new StringBuilder(); + if (IsStatic(method.Modifiers)) sb.Append("static "); + sb.Append(method.ReturnType.ToString()); + sb.Append(' '); + sb.Append(method.Identifier.Text); + if (method.TypeParameterList != null) sb.Append(method.TypeParameterList.ToString()); + sb.Append(NormalizeWs(method.ParameterList.ToString())); + foreach (var c in method.ConstraintClauses) + { + sb.Append(' '); + sb.Append(NormalizeWs(c.ToString())); + } + return NormalizeWs(sb.ToString()); + } + + private static string RenderProperty(PropertyDeclarationSyntax prop) + { + var sb = new StringBuilder(); + if (IsStatic(prop.Modifiers)) sb.Append("static "); + sb.Append(prop.Type.ToString()); + sb.Append(' '); + sb.Append(prop.Identifier.Text); + sb.Append(' '); + + if (prop.AccessorList != null) + { + var accessors = prop.AccessorList.Accessors + .Where(a => !a.Modifiers.Any(m => m.IsKind(SyntaxKind.PrivateKeyword))) + .Select(a => a.Keyword.Text + ";"); + sb.Append("{ ").Append(string.Join(" ", accessors)).Append(" }"); + } + else + { + // Expression-bodied property (=> ...): read-only. + sb.Append("{ get; }"); + } + + return NormalizeWs(sb.ToString()); + } + + // Members default to private; surface only those explicitly visible (public/internal/protected), + // and interface members (implicitly public unless marked private). + private static bool IsApiVisible(SyntaxTokenList modifiers, bool isInterface) + { + if (modifiers.Any(m => m.IsKind(SyntaxKind.PrivateKeyword))) + return false; + if (modifiers.Any(m => m.IsKind(SyntaxKind.PublicKeyword) + || m.IsKind(SyntaxKind.InternalKeyword) + || m.IsKind(SyntaxKind.ProtectedKeyword))) + return true; + return isInterface; + } + + private static bool IsExtensionMethod(TypeDeclarationSyntax type, MethodDeclarationSyntax method) + { + return type is ClassDeclarationSyntax + && IsStatic(type.Modifiers) + && method.ParameterList.Parameters.Count > 0 + && method.ParameterList.Parameters[0].Modifiers.Any(m => m.IsKind(SyntaxKind.ThisKeyword)); + } + + private static void AppendSummaryFile(StringBuilder toml, string summary, string file) + { + if (!string.IsNullOrEmpty(summary)) toml.AppendLine($"summary = {TomlString(summary)}"); + if (!string.IsNullOrEmpty(file)) toml.AppendLine($"file = {TomlString(file)}"); + } + + private static bool IsTypeVisible(SyntaxTokenList modifiers) => + modifiers.Any(m => m.IsKind(SyntaxKind.PublicKeyword) || m.IsKind(SyntaxKind.InternalKeyword)); + + private static bool IsStatic(SyntaxTokenList modifiers) => + modifiers.Any(m => m.IsKind(SyntaxKind.StaticKeyword)); + + private static string BaseList(BaseListSyntax baseList) => + baseList == null ? "" : NormalizeWs(string.Join(", ", baseList.Types.Select(t => t.ToString()))); + + private static string GetNamespace(SyntaxNode node) + { + for (var current = node.Parent; current != null; current = current.Parent) + { + switch (current) + { + case FileScopedNamespaceDeclarationSyntax fs: return fs.Name.ToString(); + case NamespaceDeclarationSyntax ns: return ns.Name.ToString(); + } + } + return ""; + } + + private static string Summary(SyntaxNode node) + { + foreach (var trivia in node.GetLeadingTrivia()) + { + if (!trivia.IsKind(SyntaxKind.SingleLineDocumentationCommentTrivia) + && !trivia.IsKind(SyntaxKind.MultiLineDocumentationCommentTrivia)) + continue; + + var structure = trivia.GetStructure(); + if (structure == null) continue; + + var summaryNode = structure.DescendantNodes() + .OfType() + .FirstOrDefault(e => e.StartTag.Name.LocalName.Text == "summary"); + if (summaryNode == null) continue; + + var raw = string.Concat(summaryNode.Content.Select(c => c.ToString())); + // Strip doc-comment leaders and inline tags, collapse whitespace. + raw = System.Text.RegularExpressions.Regex.Replace(raw, @"^\s*///?", "", System.Text.RegularExpressions.RegexOptions.Multiline); + raw = System.Text.RegularExpressions.Regex.Replace(raw, @"<[^>]+>", " "); + return NormalizeWs(raw); + } + return ""; + } + + private static string NormalizeWs(string value) => + string.IsNullOrEmpty(value) + ? "" + : System.Text.RegularExpressions.Regex.Replace(value, @"\s+", " ").Trim(); + + private static string TomlString(string value) + { + if (string.IsNullOrEmpty(value)) return "\"\""; + var escaped = value.Replace("\\", "\\\\").Replace("\"", "\\\""); + return "\"" + escaped + "\""; + } + + private static string RelativePath(string fullPath, string root) + { + var rel = fullPath.Length > root.Length && fullPath.StartsWith(root, StringComparison.OrdinalIgnoreCase) + ? fullPath.Substring(root.Length) + : fullPath; + return rel.TrimStart('\\', '/'); + } + + private static readonly string[] ExcludeDirs = { "obj", "bin", "submodules", "samples", "TestResults" }; + + private static bool IsExcluded(string path) + { + // Normalize to '/' so the check is separator-agnostic, then match whole path segments. + var segments = path.Replace('\\', '/').Split('/'); + return segments.Any(s => ExcludeDirs.Contains(s, StringComparer.OrdinalIgnoreCase)); + } + + private static string GetArg(string[] args, string name) + { + for (var i = 0; i < args.Length - 1; i++) + if (string.Equals(args[i], name, StringComparison.OrdinalIgnoreCase)) + return args[i + 1]; + return ""; + } + + private static string ReadGitHeadShort(string repoPath) + { + try + { + var gitDir = Path.Combine(repoPath, ".git"); + var head = File.ReadAllText(Path.Combine(gitDir, "HEAD")).Trim(); + string fullSha; + if (head.StartsWith("ref: ", StringComparison.Ordinal)) + { + var refPath = head.Substring(5); + var refFile = Path.Combine(gitDir, refPath.Replace('/', Path.DirectorySeparatorChar)); + if (File.Exists(refFile)) + { + fullSha = File.ReadAllText(refFile).Trim(); + } + else + { + var packed = Path.Combine(gitDir, "packed-refs"); + fullSha = ""; + if (File.Exists(packed)) + { + foreach (var line in File.ReadLines(packed)) + { + if (line.Length == 0 || line[0] == '#' || line[0] == '^') continue; + var space = line.IndexOf(' '); + if (space > 0 && line.Substring(space + 1) == refPath) + { + fullSha = line.Substring(0, space); + break; + } + } + } + } + } + else + { + fullSha = head; + } + return fullSha.Length >= 7 ? fullSha.Substring(0, 7) : fullSha; + } + catch + { + return "unknown"; + } + } + + private sealed class Totals + { + public int Classes; + public int Interfaces; + public int Enums; + public int Extensions; + public int Ctors; + public int Methods; + public int Properties; + } +} diff --git a/tools/FEx.McpServer/Services/ApiEntry.cs b/tools/FEx.McpServer/Services/ApiEntry.cs index ad923bd2..e04c0a07 100644 --- a/tools/FEx.McpServer/Services/ApiEntry.cs +++ b/tools/FEx.McpServer/Services/ApiEntry.cs @@ -5,7 +5,10 @@ public enum ApiEntryType Class, Interface, Enum, - Extension + Extension, + Constructor, + Method, + Property } public sealed class ApiEntry @@ -20,6 +23,11 @@ public sealed class ApiEntry public string Returns { get; init; } = ""; public string Base { get; init; } = ""; public bool IsStatic { get; init; } + + // Declaring type for member entries (Constructor/Method/Property); empty for top-level types. + public string Parent { get; init; } = ""; + + public bool IsMember => Type is ApiEntryType.Constructor or ApiEntryType.Method or ApiEntryType.Property; } public sealed class ProjectInfo diff --git a/tools/FEx.McpServer/Services/TomlApiSurfaceReader.cs b/tools/FEx.McpServer/Services/TomlApiSurfaceReader.cs index 10ca4a6f..c00d9285 100644 --- a/tools/FEx.McpServer/Services/TomlApiSurfaceReader.cs +++ b/tools/FEx.McpServer/Services/TomlApiSurfaceReader.cs @@ -85,6 +85,11 @@ private void LoadProjectToml(string filePath, string fileName) int enumCount = LoadEntries(sections, "enums", ApiEntryType.Enum, projectName); int extCount = LoadEntries(sections, "extensions", ApiEntryType.Extension, projectName); + // Member entries (declared per type) - not counted in ProjectInfo, surfaced via search/get_project. + LoadEntries(sections, "ctors", ApiEntryType.Constructor, projectName); + LoadEntries(sections, "methods", ApiEntryType.Method, projectName); + LoadEntries(sections, "properties", ApiEntryType.Property, projectName); + _projects.Add(new ProjectInfo { Name = projectName, @@ -118,7 +123,8 @@ private int LoadEntries( Signature = GetValue(item, "sig"), Returns = GetValue(item, "returns"), Base = GetValue(item, "base"), - IsStatic = GetValue(item, "static") == "true" + IsStatic = GetValue(item, "static") == "true", + Parent = GetValue(item, "parent") }); } @@ -140,7 +146,8 @@ public List Search(string query, string project, string type) e.Name.Contains(query, StringComparison.OrdinalIgnoreCase) || e.Namespace.Contains(query, StringComparison.OrdinalIgnoreCase) || e.Summary.Contains(query, StringComparison.OrdinalIgnoreCase) || - e.Signature.Contains(query, StringComparison.OrdinalIgnoreCase)) + e.Signature.Contains(query, StringComparison.OrdinalIgnoreCase) || + e.Parent.Contains(query, StringComparison.OrdinalIgnoreCase)) .OrderByDescending(e => e.Name.Equals(query, StringComparison.OrdinalIgnoreCase)) .ThenByDescending(e => e.Name.StartsWith(query, StringComparison.OrdinalIgnoreCase)) .ThenBy(e => e.Name) diff --git a/tools/FEx.McpServer/Tools/FExApiTools.cs b/tools/FEx.McpServer/Tools/FExApiTools.cs index d2e8cbac..c06f3ae5 100644 --- a/tools/FEx.McpServer/Tools/FExApiTools.cs +++ b/tools/FEx.McpServer/Tools/FExApiTools.cs @@ -30,7 +30,12 @@ public static string SearchApi( foreach (var entry in results.Take(30)) { - sb.AppendLine($"**{entry.Type}**: `{entry.Name}`"); + var label = entry.Type == ApiEntryType.Constructor && string.IsNullOrEmpty(entry.Name) + ? entry.Parent + : entry.Name; + sb.AppendLine($"**{entry.Type}**: `{label}`"); + if (!string.IsNullOrEmpty(entry.Parent)) + sb.AppendLine($" Member of: {entry.Parent}"); if (!string.IsNullOrEmpty(entry.Namespace)) sb.AppendLine($" Namespace: {entry.Namespace}"); sb.AppendLine($" Project: {entry.Project}"); @@ -96,7 +101,27 @@ public static string GetProjectApi( foreach (var group in entries.GroupBy(e => e.Type).OrderBy(g => g.Key)) { - sb.AppendLine($"## {group.Key}s ({group.Count()})"); + sb.AppendLine($"## {Plural(group.Key)} ({group.Count()})"); + + // Member entries are grouped under their declaring type for readability. + if (group.First().IsMember) + { + foreach (var byType in group.GroupBy(e => e.Parent).OrderBy(g => g.Key, StringComparer.OrdinalIgnoreCase)) + { + sb.AppendLine($" {byType.Key}"); + foreach (var entry in byType.OrderBy(e => e.Name, StringComparer.OrdinalIgnoreCase)) + { + var sig = string.IsNullOrEmpty(entry.Signature) ? entry.Name : entry.Signature; + sb.Append($" - `{sig}`"); + if (!string.IsNullOrEmpty(entry.Summary)) + sb.Append($" - {entry.Summary}"); + sb.AppendLine(); + } + } + sb.AppendLine(); + continue; + } + foreach (var entry in group.OrderBy(e => e.Name)) { if (entry.Type == ApiEntryType.Extension) @@ -122,6 +147,18 @@ public static string GetProjectApi( return sb.ToString(); } + private static string Plural(ApiEntryType type) => type switch + { + ApiEntryType.Class => "Classes", + ApiEntryType.Interface => "Interfaces", + ApiEntryType.Enum => "Enums", + ApiEntryType.Extension => "Extensions", + ApiEntryType.Constructor => "Constructors", + ApiEntryType.Method => "Methods", + ApiEntryType.Property => "Properties", + _ => type + "s" + }; + [McpServerTool(Name = "check_fex_freshness")] [Description("Check if the FEx API surface TOML files are up to date with the current git HEAD.")] public static string CheckFreshness(