File: rbuf_equal.pod

package info (click to toggle)
roy 1.0.8-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 3,316 kB
  • ctags: 1,564
  • sloc: ansic: 14,459; sh: 8,259; makefile: 322
file content (78 lines) | stat: -rw-r--r-- 3,106 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

=head1 NAME

rbuf_equal_* - equivalance checks for rbufs

=head1 SYNOPSIS

#include <roy.h>

unsigned int rbuf_equal_rbuf (const RBuf *buf1, const RBuf *buf2);

unsigned int rbuf_equal_rbufcase (const RBuf *buf1, const RBuf *buf2);

unsigned int rbuf_equal_strcase (const RBuf *buf, const char *str);

unsigned int rbuf_equal_str (const RBuf *buf, const char *str);

unsigned int rbuf_equal_data (const RBuf *buf, const char *str, const unsigned int len);

unsigned int rbuf_equal_rbuf_len (const RBuf *buf1, const RBuf *buf2, unsigned int len);

unsigned int rbuf_equal_str_len (const RBuf *buf, const char *str, unsigned int len);


=head1 DESCRIPTION

These calls do not return a distance from equal like strcmp(3), but
only check to see if the two arguements are equivalant.

Calls to rbuf_equal_rbuf(3), rbuf_equal_data(3) and rbuf_equal_str(3)
check to see if the two arguments are byte for byte equal.

Calls to rbuf_equal_rbufcase(3) and rbuf_equal_strcase(3) convert each
byte of the two arguments to uppercase and then checks if they are equal.

rbuf_equal_rbuf_len(3) compares at most the first I<len> bytes of each
RBuf.

rbuf_equal_str_len(3) compares at most the first I<len> bytes of 
the I<buf> with I<str>.

=head1 RETURN VALUE

Each of these call returns TRUE if the two arguments are effectivly equal.
If the two arguments are not equivalant these calls return FALSE.

=head1 ERRORS

These calls never fail.

=head1 FUNCTION

The rbuf equivalance calls are implemented using functions.

=head1 SEE ALSO

L<rbuf(3)|rbuf(3)>, L<rbuf_append(3)|rbuf_append(3)>, 
L<rbuf_append_char(3)|rbuf_append_char(3)>, L<rbuf_append_data(3)|rbuf_append_data(3)>, 
L<rbuf_append_rbuf(3)|rbuf_append_rbuf(3)>, L<rbuf_append_sprintf(3)|rbuf_append_sprintf(3)>, 
L<rbuf_append_str(3)|rbuf_append_str(3)>, L<rbuf_append_vsprintf(3)|rbuf_append_vsprintf(3)>, 
L<rbuf_auto(3)|rbuf_auto(3)>, L<rbuf_down(3)|rbuf_down(3)>, 
L<rbuf_empty(3)|rbuf_empty(3)>, L<rbuf_equal_data(3)|rbuf_equal_data(3)>, 
L<rbuf_equal_rbuf(3)|rbuf_equal_rbuf(3)>, L<rbuf_equal_rbuf_len(3)|rbuf_equal_rbuf_len(3)>, 
L<rbuf_equal_rbufcase(3)|rbuf_equal_rbufcase(3)>, L<rbuf_equal_str(3)|rbuf_equal_str(3)>, 
L<rbuf_equal_str_len(3)|rbuf_equal_str_len(3)>, L<rbuf_equal_strcase(3)|rbuf_equal_strcase(3)>, 
L<rbuf_erase(3)|rbuf_erase(3)>, L<rbuf_float(3)|rbuf_float(3)>, 
L<rbuf_free(3)|rbuf_free(3)>, L<rbuf_hash(3)|rbuf_hash(3)>, 
L<rbuf_insert(3)|rbuf_insert(3)>, L<rbuf_last(3)|rbuf_last(3)>, 
L<rbuf_len(3)|rbuf_len(3)>, L<rbuf_long(3)|rbuf_long(3)>, 
L<rbuf_new(3)|rbuf_new(3)>, L<rbuf_new_with_sprintf(3)|rbuf_new_with_sprintf(3)>, 
L<rbuf_own(3)|rbuf_own(3)>, L<rbuf_prepend(3)|rbuf_prepend(3)>, 
L<rbuf_prepend_char(3)|rbuf_prepend_char(3)>, L<rbuf_prepend_data(3)|rbuf_prepend_data(3)>, 
L<rbuf_prepend_rbuf(3)|rbuf_prepend_rbuf(3)>, L<rbuf_prepend_str(3)|rbuf_prepend_str(3)>, 
L<rbuf_rdonly(3)|rbuf_rdonly(3)>, L<rbuf_set_to(3)|rbuf_set_to(3)>, 
L<rbuf_split(3)|rbuf_split(3)>, L<rbuf_sprintf(3)|rbuf_sprintf(3)>, 
L<rbuf_str(3)|rbuf_str(3)>, L<rbuf_truncate(3)|rbuf_truncate(3)>, 
L<rbuf_up(3)|rbuf_up(3)>, L<roy(3)|roy(3)>