Ags.FileUtil

Fields

Name

Type

Access

Description

app_encoding

str

r/w

converter

object

r/w

encoding

str

r/w

file_version

str

r/w

reverse_converter

object

r/w

Methods

class

alloc (app_encoding, encoding)

copy ()

free ()

get_app_encoding ()

get_complex (str)

get_double (str)

get_encoding ()

get_file_version ()

get_float (str)

get_int (str)

get_int64 (str)

get_string (str, max_length)

get_uint (str)

get_uint64 (str)

put_complex (value)

put_double (value)

put_float (value)

put_int (value)

put_int64 (value)

put_string (str, length)

put_uint (value)

put_uint64 (value)

set_file_version (file_version)

Details

class Ags.FileUtil
classmethod alloc(app_encoding, encoding)
Parameters:
  • app_encoding (str) – the application encoding

  • encoding (str) – the file encoding

Returns:

a new Ags.FileUtil-struct

Return type:

Ags.FileUtil

Allocate Ags.FileUtil-struct

New in version 6.3.0.

copy()
Returns:

a pointer of the new Ags.FileUtil-struct

Return type:

object or None

Create a copy of self.

New in version 6.3.0.

free()

Free the memory of self.

New in version 6.3.0.

get_app_encoding()
Returns:

the application encoding

Return type:

str

Get application encoding of self.

New in version 6.3.0.

get_complex(str)
Parameters:

str (str) – the string

Returns:

the complex floating point number

Return type:

Ags.Complex

Get complex floating point number from string.

New in version 6.3.0.

get_double(str)
Parameters:

str (str) – the string

Returns:

the double precision size floating point number

Return type:

float

Get double precision size floating point number from string.

New in version 6.3.0.

get_encoding()
Returns:

the encoding

Return type:

str

Get encoding of self.

New in version 6.3.0.

get_file_version()
Return type:

str

set file version of self.

New in version 6.3.0.

get_float(str)
Parameters:

str (str) – the string

Returns:

the arbitary size floating point number

Return type:

float

Get arbitary size floating point number from string.

New in version 6.3.0.

get_int(str)
Parameters:

str (str) – the string to convert

Returns:

the converted integer

Return type:

int

Get integer from string.

New in version 6.3.0.

get_int64(str)
Parameters:

str (str) – the string to convert

Returns:

the converted long long integer

Return type:

int

Get long long integer from string.

New in version 6.3.0.

get_string(str, max_length)
Parameters:
  • str (str) – the string

  • max_length (int) – the maximum length of string

Returns:

the newly allocated string

Return type:

str

Get string from str.

New in version 6.3.0.

get_uint(str)
Parameters:

str (str) – the string to convert

Returns:

the converted unsigned integer

Return type:

int

Get unsigned integer from string.

New in version 6.3.0.

get_uint64(str)
Parameters:

str (str) – the string to convert

Returns:

the converted unsigned long long integer

Return type:

int

Get unsigned long long integer.

New in version 6.3.0.

put_complex(value)
Parameters:

value (Ags.Complex) – the value

Returns:

the newly allocated string

Return type:

str

Put complex floating point number to string.

New in version 6.3.0.

put_double(value)
Parameters:

value (float) – the value

Returns:

the newly allocated string

Return type:

str

Put double precision size floating point number to string.

New in version 6.3.0.

put_float(value)
Parameters:

value (float) – the value

Returns:

the newly allocated string

Return type:

str

Put arbitary size floating point number to string.

New in version 6.3.0.

put_int(value)
Parameters:

value (int) – the value

Returns:

the newly allocated string

Return type:

str

Put integer to string.

New in version 6.3.0.

put_int64(value)
Parameters:

value (int) – the value

Returns:

the newly allocated string

Return type:

str

Put long long integer to string.

New in version 6.3.0.

put_string(str, length)
Parameters:
  • str (str) – the string

  • length (int) – the length of string

Returns:

the newly allocated string

Return type:

str

Put str to string.

New in version 6.3.0.

put_uint(value)
Parameters:

value (int) – the value

Returns:

the newly allocated string

Return type:

str

Put unsigned integer to string.

New in version 6.3.0.

put_uint64(value)
Parameters:

value (int) – the value

Returns:

the newly allocated string

Return type:

str

Put unsigned long long integer to string.

New in version 6.3.0.

set_file_version(file_version)
Parameters:

file_version (str) –