ApiArgumentHelpers

Full name SMRUCC.Rsharp.ApiArgumentHelpers Assembly REnv Members 8

01 Syntax

SMRUCC.Rsharp.ApiArgumentHelpers

02 Methods

Name	Overloads	Summary
slot	1	create a slot value reference inside a tuple ApiArgumentHelpers.list()) for construct a new list data
GetNamedValueTuple	1	create a name tagged value object from a given data source value
FileStreamWriter	1	open stream for file write
GetFileStream	1	get a file stream object
list	1
GetNamedValueTuple	1
GetDoubleRange	1

03 Fields

Name	Overloads	Summary
ReadOnlyRawByteStream	1	the memory stream object that construct via the given byte array works in readonly mode!

04 Members

method slot #

slot(String)

create a slot value reference inside a tuple ApiArgumentHelpers.list() for construct a new list data

Parameters

Name	Type	Description
`name`	`String`	-

method GetNamedValueTuple #

GetNamedValueTuple``1(Object, Environment, String)

create a name tagged value object from a given data source value

Type Parameters

Name	Description
`T`

Parameters

method FileStreamWriter #

FileStreamWriter(Environment, Object, Action(Of Stream))

open stream for file write

Parameters

Name	Type	Description
`file`	Environment	-
`write`	`Object`	-

method GetFileStream #

GetFileStream(Object, FileAccess, Environment, Boolean, Boolean, Boolean)

get a file stream object

Remarks

base on the value of mode, this function has different behaviour:

Parameters

Name	Type	Description
`file`	`Object`	the file resource could be one of the: a valid file path to a filesystem location a stream object that can be read/write based on the mode context a raw bytes array for construct a memory stream in this function(readonly)
`mode`	`FileAccess`	-
`env`	Environment	-
`suppress`	`Boolean`	-

field ReadOnlyRawByteStream #

ReadOnlyRawByteStream

the memory stream object that construct via the given byte array works in readonly mode!

method list #

list(ArgumentReference())

method GetNamedValueTuple #

GetNamedValueTuple(Object, Environment, String)

method GetDoubleRange #

GetDoubleRange(Object, Environment, String, String)