Overview

Maintainer[s]:

Table Of Contents

Design change Version 1.0 vs 2.0

Caching

varexchangeRate=newLive(()=>newTextOf(newUri("https://api.exchangeratesapi.io/latest")));

Caching envelopes

publicsealedclassMyLiveTextObject:TextEnvelope{MyLiveTextObject(...):base(...,live:true)}

Exception: Input and output

Shorthand Generics

newMapOf(newKvpOf("Key","Value"));//A map string to stringnewMapOf<int>(newKvpOf<int>("Key",123));//A map string to generic typenewMapOf<int,int>(newKvpOf<int,int>(123,123));//A map generic type to generic type

Migration

Maps

varmap=newMapOf<string,int>("Amount",100);

Kvp

varmap=newMapOf<string,int>(newKvpOf<string,int>("age",28),newKvpOf<string,int>("height",184),)

Lazy values

//If you ask the map for "github", it will execute the function and retrieve the content. The content of the first kvp is NOT retrieved.vargithubContent=newMapOf<string,string>(newKvpOf<string,string>("google",()=>newTextOf(newUri("https://www.google.de"))),newKvpOf<string,string>("github",()=>newTextOf(newUri("https://www.github.com"))))["github"];//Note that MapOf is sticky, so if you need live content, decorate the map:varliveContent=newLiveMap<string,string>(()=>newMapOf<string,string>(newKvpOf<string,string>("google",()=>newTextOf(newUri("https://www.google.de"))),newKvpOf<string,string>("github",()=>newTextOf(newUri("https://www.github.com")))))["github"];//Beware: If you have lazy values, you normally do NOT want to execute all functions. Atoms prevents it, so the following will fail:foreach(vardoNotDoThisingithubContent){   ...}//If you know that you need all values, simply enumerate the keys:foreach(varkeyingithubContent.Keys){varvalue=githubContent[key];}

Shorthand Generics

newMapOf(newKvpOf("Key","Value"))//Use without generic to get a string-string mapnewMapOf<int>(newKvpOf("Key",100))//Use without generic to get a string-generic map

Shorthand Stringmap

vartranslations=newMapOf("Objects","Objekte","Functions","Funktionen","Bigmac","Viertelpfünder mit Käse")

Functions

//Function with input and outputpublicinterfaceIFunc<In,Out>{OutInvoke(Ininput);}//Function with output onlypublicinterfaceIFunc<Out>{OutInvoke();}//Function with two inputs and one outputpublicinterfaceIFunc<In1,In2,Out>{OutInvoke(In1input1,In2input2);}//Function with input onlypublicinterfaceIAction<In>{voidInvoke(Ininput);}

Execute functions

vari=newFuncOf<int,int>((number)=>number++).Invoke(1);//i will be 2

Cache function output

varurl=newUrl("https://www.google.de");varf=newStickyFunc<Url,IText>((u)=>newTextOf(newInputOf(u))).Invoke(url);varhtml=f.Invoke();//will load the page content from the webvarhtml=f.Invoke();//will load the page content from internal cache

Retry a function

newRetryFunc<int,int>(    input=>{if(newRandom().NextDouble()>input){thrownewArgumentException("May happen");}return0;},100000).Invoke(0.3d);//will try 100.000 times to get a random number under 0.3

Repeat a function

varcount=0;newRepeatedFunc<int,int>(        input=>input++,3).Invoke(count);//will return 3

Use a fallback if a function fails

newFuncWithFallback<string,string>(    name=>{thrownewException("Failure");},    ex=>"Never mind, "+name).Invoke("Miro");//will be "Never mind, Miro"

IO Input / Output

publicinterfaceIInput{StreamStream();}publicinterfaceIOutput{StreamStream();}

Input Stream of a file

newInputOf(newUri(@"file:///c:\secret-content-inside.txt")).Stream();//returns a readable stream of the file

Output Stream to a file

newOutputTo(newUri(@"file:///c:\secret-content-inside.txt")).Stream();//returns a readable stream of the file

Output Stream of Console

newConsoleOutput().Stream();//Default console outputnewConsoleErrorOutput().Stream();//Console error output

Read file content as string

varfileContent=newTextOf(newInputOf(newUri(@"file:///c:\secret-content-inside.txt"))).AsString();//reads the content and gives it as text

Read Url page as string

newTextOf(newInputOf(newUrl("https://www.google.de"))).AsString();//gives the content html of the google start page

Read a file and use a fallback if fails

newTextOf(newInputWithFallback(newInputOf(newUri(Path.GetFullPath("/this-file-does-not-exist.txt"))//file to read),newInputOf(newTextOf("Alternative text!"))//fallback to use).AsString();//will be "Alternative Text!"

Get the length of a file

longlength=newLengthOf(newInputOf(newUri(@"file:///c:\great-content-inside.txt"))).Value();//will be the number of bytes in the file

Copy all you are reading from a Stream to a output stream

newLengthOf(newTeeInput("Welcome to the world of c:!",newOutputTo(newUri(@"file:///c:\greeting.txt")))).Value();//will write "Welcome to the world of c:!" to the file c:\greeting.txt.//This happens because TeeInput puts every byte that is read to the specified output.//When calling Value(), every byte is read to count the content.

Copy input/output 1:1 while reading or writing

varinPath=Path.GetFullPath(@"file:///c:\input-file.txt");varoutPath=Path.GetFullPath(@"file:///c:\output-file.txt");newLengthOf(newTeeInput(newInputOf(newUri(inPath)),newOutputTo(newUri(outPath)))).Value();//since LengthOf will read all the content when calling Value(), all that has been read will be copied to the output path.//Alternative: Copy to Console outputnewLengthOf(newTeeInput(newInputOf(newUri(inPath)),newConsoleOutput())).Value();//will dump the read content to output

Cache what you have read

newTextOf(newStickyInput(newInputOf(newUrl("http://www.google.de"))));varhtml1=input.AsString();//will read the url from the webvarhtml2=input.AsString();//will return from the cache

Enumerables

publicinterfaceIEnumerable<outT>:IEnumerable{IEnumerator<T>GetEnumerator();}publicinterfaceIEnumerator<outT>:IEnumerator,IDisposable{TCurrent{get;}}

Base Objects

//use without generic and get an IEnumerable<string>varstrings=newManyOf("a string","another string");//use with generic and get an IEnumerable<T>varints=newManyOf<int>(98,20);

Filter

newFiltered<string>(newList<string>(){"A","B","C"},(input)=>input!="B");//will be a list with "A" and "C" inside

Get an item from an enumerable

newItemAt<int>(newManyOf<int>(1,2,3),2).Value();//will be 3 (Zero based)//To get the first item simply do not specify a position:newItemAt<int>(newManyOf<int>(1,2,3)).Value();//will be 1//To get an item with a fallback if it isn't there:Stringfallback="fallback";newItemAt<string>(newManyOf<string>(),//empty list,12,//position 12 which does not existfallback).Value();//will be "fallback"

Sort lists

//Default sorting is forwardnewSorted<int>(newManyOf<int>(3,2,10,44,-6,0));//items will be sorted to -6, 0, 2, 3, 10, 44//Use another comparator for sortingnewSorted<string>(IReverseComparer<string>.Default,//comparator is from C#.NET librarynewManyOf<string>("a","c","hello","dude","Friend"));//will be sorted to hello, Friend, dude, c, a

Count items in enumerables

varl=newLengthOf<int>(newManyOf<int>(1,2,3,4,5)).Value();//will be 5

Map items in an enumerable to another type

ITextgreeting=newItemAt<IText>(newMapped<String,IText>(newManyOf<string>("hello","world","damn"),            input=>newUpperText(newTextOf(input))//is applied to every item and will make a uppertext of it),0).Value();//will be "HELLO"

// Mapping items of a list to another type using index of itemsnewMapped<string,string>(newList<string>(){"One","Two",Three"},(input,index)=>$"{input}={index+1}");// Returns a IEnumerable<string> with Content {"One=1", "Two=2", Three=3"}

Create cycling lists

//here is a list with 3 items and you call the 7th item. The cycled list will not fail but start over when it reaches the end.newItemAt<string>(newCycled<string>(//make a cycled list of the enumerable with 3 itemsnewManyOf<string>("one","two","three")),7).Value();//will be "two"

Join lists together

newLengthOf(newJoined<string>(newManyOf<string>("hello","world","Miro"),newManyOf<string>("how","are","you"),newManyOf<string>("what's","up"))).Value();//will be 8

Limit lists

newSumOfInts(newHeadOf<int>(newManyOf<int>(0,1,2,3,4),3)).Value();//will be 3 (0 + 1 + 2)

Cache list contents

//this snippet has an endless list, which then is limited to the size. Every time someone calls the list, size increases and the list would grow. But StickyEnumerable prevents that and always returns the same list.intsize=2;varlist=newStickyEnumerable<int>(newHeadOf<int>(newEndless<int>(1),newScalarOf<int>(()=>Interlocked.Increment(refsize))));newLengthOf(list).Value();//will be 2newLengthOf(list).Value();//will be 2

Scalar

publicinterfaceIScalar<T>{TValue();}

Encapsulate objects

varsc1=newScalarOf<string>("this brave string");stringstr=sc.Value();//returns the stringvarsc2=newScalarOf<IEnumerable<int>>(newManyOf<int>(1,2,3,4,5));IEnumerable<int>lst=sc2.Value();//returns the list

Encapsulate functions

varsc=newScalarOf<string>(()=>newTextOf(newInputOf(newUrl("http://www.ars-technica.com"))).AsString());stringhtml=sc.Value();//will fetch the html from the url and return it as a string

Cache function results

varsc=newStickyScalar<string>(()=>newTextOf(newInputOf(newUrl("http://www.ars-technica.com"))).AsString()).Value();stringhtml=sc.Value();//will fetch the html from the url and return it as a stringstringhtml2=sc.Value();//will return the html from the cache

Logical And

varresult=newAnd<True>(()=>true,()=>false,()=>true).Value();//will be falsevarnumber=3;newAnd<True>(()=>true,//function that returns true()=>number==4//function that returns false).Value();//will be false//you can also pass scalars into AND, and more.

Logical ternary

newTernary<bool,int>(newTrue(),//condition is true6,//if true16//if false).Value();//will be 6newTernary<int,int>(5,//input to test    input=>input>3,//condition    input=>input=8,//return if condition true    input=>input=2//return if condition false).Value();//will be 8

Text

publicinterfaceIText:IEquatable<IText>{StringAsString();}

Transform text

//Lower a textnewLowerText(newTextOf("HelLo!")).AsString();//will be "hello!"//upper a textnewUpperText(newTextOf("Hello!")).AsString();//will be "HELLO!"

Reverse text

newReversedText(newTextOf("Hello!")).AsString();//"!olleH"

Trim text

newTrimmedText(newTextOf("  Hello!\t ")).AsString();// "Hello!"newTrimmedLeftText(newTextOf("  Hello!\t ")).AsString();// "Hello!   \t "newTrimmedRightText(newTextOf("  Hello!\t ")).AsString();// "  Hello!"

Split text

IEnumerable<Text>splitted=newSplitText("Hello world!","\\s+");

Replace text

newReplacedText(newTextOf("Hello!"),"ello",// what to replace"i"// replacement).AsString();// "Hi!"

Join texts

newJoinedText(" ","hello","world").AsString();// "hello world"

Format texts with arguments

newFormattedText("{0} Formatted {1}",1,"text").AsString();// "1 Formatted text"

Convert from and to text

//text from a string with encodingvarcontent="Greetings, Mr.Freeman!";newTextOf(content,Encoding.UTF8);//text from a input with default encodingvarcontent="Hello, my precious coding friend! with default charset";newTextOf(newInputOf(content));//text from a StringReaderStringsource="Hello, Dude!";newTextOf(newStringReader(source),Encoding.UTF8);//text from a char arraynewTextOf('O',' ','q','u','e',' ','s','e','r','a',' ','q','u','e',' ','s','e','r','a');//text from a byte arraybyte[]bytes=newbyte[]{(byte)0xCA,(byte)0xFE};newTextOf(bytes);//text from a StringBuilderStringstarts="Name it, ";Stringends="then it exists!";Assert.True(newTextOf(newStringBuilder(starts).Append(ends));//text from an exceptionnewTextOf(newIOException("It doesn't work at all"));

LinQ Analogy

Standard Query Operators