Deveel.Data.Store.IArea Interface Reference

An interface for access the contents of an area of a store. More...

Inheritance diagram for Deveel.Data.Store.IArea:

Public Member Functions
void	CopyTo (IArea destArea, int size)
	Copies the given amount of bytes from the current position of the this area to another one. More...
int	Read (byte[] buffer, int offset, int length)
	Reads an array of bytes from the underlying IArea and advances the position by length . More...
void	Write (byte[] buffer, int offset, int length)
void	Flush ()

Properties
long	Id [get]
	Returns the unique identifier that represents this area. More...
bool	IsReadOnly [get]
	Gets a value indicating whether this area can be written or not. More...
long	Position [get, set]
	Returns or sets the current position of the pointer within the area. More...
int	Length [get]

Detailed Description

An interface for access the contents of an area of a store.

Definition at line 23 of file IArea.cs.

Member Function Documentation

void Deveel.Data.Store.IArea.CopyTo	(	IArea	destArea,
		int	size
	)

Copies the given amount of bytes from the current position of the this area to another one.

Parameters

destArea	The IArea where to write.
size	The number of bytes to Write.

Implemented in Deveel.Data.Store.StoreBase.StoreArea, and Deveel.Data.Store.InMemoryStore.InMemoryArea.

void Deveel.Data.Store.IArea.Flush

(

)

Implemented in Deveel.Data.Store.StoreBase.StoreArea, and Deveel.Data.Store.InMemoryStore.InMemoryArea.

int Deveel.Data.Store.IArea.Read	(	byte[]	buffer,
		int	offset,
		int	length
	)

Reads an array of bytes from the underlying IArea and advances the position by length .

Parameters

buffer	The destination buffer into which to Read the number of bytes given from the area.
offset	The offset within the buffer from where to start writing the byte Read into.
length	The number of bytes to Read from the area. This is also the incremental size of the position of the area.

Returns

Returns the number of bytes actually Read from the IArea.

Implemented in Deveel.Data.Store.StoreBase.StoreArea, and Deveel.Data.Store.InMemoryStore.InMemoryArea.

void Deveel.Data.Store.IArea.Write	(	byte[]	buffer,
		int	offset,
		int	length
	)

Parameters

buffer
offset
length

Implemented in Deveel.Data.Store.StoreBase.StoreArea, and Deveel.Data.Store.InMemoryStore.InMemoryArea.

Property Documentation

long Deveel.Data.Store.IArea.Id

get

Returns the unique identifier that represents this area.

The id is -1 if the area is the store's static area. Otherwise the id is a positive number that will not exceed 60 bits of the long.

Definition at line 31 of file IArea.cs.

bool Deveel.Data.Store.IArea.IsReadOnly

get

Gets a value indicating whether this area can be written or not.

If this area is read-only, any attempt to call Write method will throw an exception.

Definition at line 40 of file IArea.cs.

int Deveel.Data.Store.IArea.Length

get

Definition at line 50 of file IArea.cs.

long Deveel.Data.Store.IArea.Position

getset

Returns or sets the current position of the pointer within the area.

The position starts at beginning of the area.

Definition at line 48 of file IArea.cs.

---

The documentation for this interface was generated from the following file:

• /var/calculate/remote/distfiles/egit-src/deveeldb.git/src/deveeldb/Deveel.Data.Store/IArea.cs