mir/openvswitch
2
0
Fork 0
mirror of https://github.com/openvswitch/ovs synced 2025-10-27 15:18:06 +00:00
Code Issues Releases Wiki Activity

dynamic-string: Document a few functions.

Browse Source 
Signed-off-by: Ben Pfaff <blp@nicira.com>
This commit is contained in:
Ben Pfaff
2012-02-17 17:00:06 -08:00
parent 000ad52df7
commit 541bc79f73
2 changed files with 20 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
lib/dynamic-string.c
View File

@@ -1,5 +1,5 @@
/*
* Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
* Copyright (c) 2008, 2009, 2010, 2011, 2012 Nicira Networks.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -23,6 +23,7 @@
#include "timeval.h"
#include "util.h"
/* Initializes 'ds' as an empty string buffer. */
void
ds_init(struct ds *ds)
{
@@ -31,12 +32,16 @@ ds_init(struct ds *ds)
ds->allocated = 0;
}
/* Sets 'ds''s length to 0, effectively clearing any existing content. Does
* not free any memory. */
void
ds_clear(struct ds *ds)
{
ds->length = 0;
}
/* Reduces 'ds''s length to no more than 'new_length'. (If its length is
* already 'new_length' or less, does nothing.) */
void
ds_truncate(struct ds *ds, size_t new_length)
{
@@ -46,6 +51,9 @@ ds_truncate(struct ds *ds, size_t new_length)
}
}
/* Ensures that at least 'min_length + 1' bytes (including space for a null
* terminator) are allocated for ds->string, allocating or reallocating memory
* as necessary. */
void
ds_reserve(struct ds *ds, size_t min_length)
{
@@ -56,6 +64,9 @@ ds_reserve(struct ds *ds, size_t min_length)
}
}
/* Appends space for 'n' bytes to the end of 'ds->string', increasing
* 'ds->length' by the same amount, and returns the first appended byte. The
* caller should fill in all 'n' bytes starting at the return value. */
char *
ds_put_uninit(struct ds *ds, size_t n)
{