FastaVector 1.0.0-beta
FastaVectorString Struct Reference

A store for FASTA data, either headers or sequences. More...

#include <FastaVectorString.h>

Data Fields

char * charData
 the array of characters held by the string. More...
 
size_t capacity
 the current maximum capacity of the string. More...
 
size_t count
 the number of characters actually contained in the string. More...
 

Related Functions

(Note that these are not member functions.)

bool fastaVectorStringInit (struct FastaVectorString *vector)
 initialize the given FastaVectorString. More...
 
void fastaVectorStringDealloc (struct FastaVectorString *vector)
 deinitializes the given FastaVectorString. More...
 
bool fastaVectorStringAddChar (struct FastaVectorString *vector, const char c)
 append a character to the FastaVectorString, growing the string's interal buffer if necessary. More...
 

Detailed Description

A store for FASTA data, either headers or sequences.

Friends And Related Function Documentation

◆ fastaVectorStringAddChar()

bool fastaVectorStringAddChar ( struct FastaVectorString vector,
const char  c 
)
related

append a character to the FastaVectorString, growing the string's interal buffer if necessary.

Parameters
vectorthe FastaVectorString to modify
cthe character to append
Returns
true on success, false on failure

◆ fastaVectorStringDealloc()

void fastaVectorStringDealloc ( struct FastaVectorString vector)
related

deinitializes the given FastaVectorString.

Parameters
vectorthe FastaVectorString to deinitialize

◆ fastaVectorStringInit()

bool fastaVectorStringInit ( struct FastaVectorString vector)
related

initialize the given FastaVectorString.

Parameters
vectorthe FastaVectorString to initialize
Returns
true on success, false on failure

Field Documentation

◆ capacity

size_t FastaVectorString::capacity

the current maximum capacity of the string.

◆ charData

char* FastaVectorString::charData

the array of characters held by the string.

◆ count

size_t FastaVectorString::count

the number of characters actually contained in the string.


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